Table of Contents

Interlocuteurs

Présentation générale de l'API et finalité fonctionnelle

Ces API permettent d'interagir avec les interlocuteurs du cabinet sur Cegid Loop :

POST/createInterlocutor

Cette API crée un interlocuteur dans le cabinet.

Lien vers la documentation technique

Cas d'usage

  • l'API permet d'ajouter un interlocuteur au sein du cabinet.

Procédure

Il faut appeler un endpoint permettant d'ajouter l'interlocuteur voulu :

https://api.cegid.com/loop-api-publiques/createInterlocutor

Route Méthode http Description
/createInterlocutor POST Ajout d'un interlocuteur du cabinet

Paramétrage de l’appel

Méthode http pour la demande : POST

Header(s) attendu(s) obligatoire(s) de la demande

Champ Description
Ocp-Apim-Subscription-Key Subscription key
x-apikey API Key & Secret

Body de la demande

Champ Type Description Obligatoire
email string Email de l'interlocuteur Oui
nom string Nom de l'interlocuteur Oui
prenom string Prénom de l'interlocuteur Non
telephoneMobile string Téléphone mobile de l'interlocuteur Non
telephoneFixe string Téléphone fixe de l'interlocuteur Non
roleOrga string Rôle organisationnel - gestion des droits techniques. Ex.: Chef d'entreprise, Comptable de la TPE Non
accesSocial boolean Indique si l'interlocuteur a accès au social Non
actif boolean Indique si l'interlocuteur est actif Non
defaultIssuer boolean Indique si le compte microsoft est pro ou perso Non
codeDossier string Dossier lié à l'interlocuteur Non

Exemple de body

{
    "email": "interloc1@cabinettest.onmicrosoft.com",
    "nom": "TEST_NOM",
    "prenom": "TEST_PRENOM",
    "telephoneMobile" : "01 02 00 03 04",
    "telephoneFixe" : "01 02 00 03 04",
    "roleOrga": "Chef d'entreprise",
    "accesSocial": "false",
    "actif": true,
    "defaultIssuer": true,
    "codeDossier": "DOSSIER1"
}

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

Champ Type Description
module string cabinet
className string interlocuteur
data object Contient les différentes données ci-dessous
data.objectId string Identifiant unique de l'objet
data.$status string Statut de l'objet
data.revisionId string Identifiant de la révision

Exemple de retour

{
    "module": "cabinet",
    "className": "interlocuteur",
    "data": {
        "objectId": "32c79d0b-9277-49c8-987b-17d527309c9a",
        "$status": "none",
        "revisionId": "0x00000000000007E4"
    }
}

PUT/updateInterlocutor

Cette API permet de mettre à jour les informations d'un interlocuteur dans le cabinet.

Lien vers la documentation technique

Cas d'usage

  • l'API permet de modifier un interlocuteur au sein du cabinet.

Procédure

Il faut appeler un endpoint permettant de mettre à jour un interlocuteur au sein d'un cabinet :

https://api.cegid.com/loop-api-publiques/updateInterlocutor

Route Méthode http Description
/updateInterlocutor POST Mise à jour d'un interlocuteur du cabinet

Paramétrage de l’appel

Méthode http pour la demande : PUT

Header(s) attendu(s) obligatoire(s) de la demande

Champ Description
Ocp-Apim-Subscription-Key Subscription key
x-apikey API Key & Secret

Body de la demande

Champ Type Description Obligatoire
email string Email de l'interlocuteur Oui
nom string Nom de l'interlocuteur Non
prenom string Prénom de l'interlocuteur Non
telephoneMobile string Téléphone mobile de l'interlocuteur Non
telephoneFixe string Téléphone fixe de l'interlocuteur Non
roleOrga string Rôle organisationnel - gestion des droits techniques. Ex.: Chef d'entreprise, Comptable de la TPE Non
accesSocial boolean Indique si l'interlocuteur a accès au social Non
actif boolean Indique si l'interlocuteur est actif Non
defaultIssuer boolean Indique si le compte microsoft est pro ou perso Non
codeDossier string Dossier lié à l'interlocuteur Non

Exemple de body

{
    "email": "interloc1@cabinettest.onmicrosoft.com",
    "codeDossier": "DOSSIER1",
    "prenom": "TEST_PRENOM",
    "nom": "TEST_NOM",
    "telephoneMobile" : "01 02 00 03 04",
    "telephoneFixe" : "01 02 00 03 04",
    "roleOrga": "Comptable de la TPE",
    "accesSocial": "false",
    "actif": true,
    "defaultIssuer": true
}

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

Champ Type Description
module string cabinet
className string interlocuteur
data object Contient les différentes données ci-dessous
data.objectId string Identifiant unique de l'objet
data.$status string Statut de l'objet
data.revisionId string Identifiant de la révision

Exemple de retour

{
    "module": "cabinet",
    "className": "interlocuteur",
    "data": {
        "objectId": "32c79d0b-9277-49c8-987b-17d527309c9a",
        "$status": "none",
        "revisionId": "0x00000000000007E4"
    }
}