Offre Collaborative Cabinet

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

Ces APIs permettent d'interagir sur le paramétrage des offres collaboratives cabinet de Cegid Loop :

POST/collaborativeOffer/addOffer

Avis de Dépréciation: Cette API est dépréciée depuis le 01/07/2024. Elle a été remplacée par /addCollaborativeOffer. Veuillez utiliser la nouvelle API pour toutes les futures demandes.

Migration: Pour des détails sur l'utilisation de l'API /addCollaborativeOffer, veuillez consulter la Documentation de la Nouvelle API.

POST/collaborativeOffer/addOffer

Avis de Dépréciation: Cette API est dépréciée depuis le 01/07/2024. Elle a été remplacée par /addCollaborativeOffer. Veuillez utiliser la nouvelle API pour toutes les futures demandes.

Migration: Pour des détails sur l'utilisation de l'API /addCollaborativeOffer, veuillez consulter la Documentation de la Nouvelle API.

POST/collaborativeOffer/addCollaborativeOffer

Ajout d'une offre collaborative à un dossier spécifique associé à un interlocuteur existant sans créer de nouveaux interlocuteurs.

Lien vers la documentation technique

Cas d'usage

  • Associer une offre collaborative à un dossier précis : Utilisez cette API pour associer une offre collaborative à un dossier spécifique pour un interlocuteur déjà existant dans le système.

  • Établir une association dossier-interlocuteur : Si le dossier n'est pas encore associé à l'interlocuteur, l'API crée cette association et ajoute l'offre collaborative au dossier.

  • Ajouter une offre à un dossier existant : Si le dossier est déjà associé à l'interlocuteur, l'API ajoute simplement l'offre collaborative au dossier existant.

Procédure

Il faut appeler un endpoint permettant d'ajouter une offre collaborative à un dossier spécifique, associé à un interlocuteur existant:

https://api.cegid.com/loop-api-publiques/collaborativeOffer/addCollaborativeOffer

Route Méthode http Description
/addCollaborativeOffer POST Ajoute une offre collaborative

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 Adresse e-mail de l'interlocuteur auquel l'offre collaborative sera ajoutée Oui
codeDossier string Code du dossier client auquel l'offre collaborative sera ajoutée Oui
offre string Type d'offre à ajouter au dossier. Les valeurs possibles sont: start, consultation, co-production, cac Oui

Exemple de body

{
  "email" : "userteams@outlook.fr",
  "codeDossier": "CEGID003",
  "offre": "consultation"
}

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
message string message

Exemple de retour

{
  "message": "L'offre consultation a été ajoutée au dossier client CEGID003 pour l'interlocuteur userteams@outlook.fr"
}

Note: L'API ne gère pas la création d'interlocuteurs. Elle se concentre uniquement sur l'association d'offres aux dossiers pour des interlocuteurs existants.

POST/collaborativeOffer/removeOffer

Supprime une offre collaborative d'un dossier client et révoque les droits d'accès au dossier et au SharePoint de tous les utilisateurs clients associés à cette offre pour le dossier.

Lien vers la documentation technique

Cas d'usage

  • Supprimer une offre collaborative d'un dossier client de tous les utilisateurs associés à cette offre pour ce dossier.

  • Révoquer les droits d'accès au dossier et au SharePoint de tous les utilisateurs associés à l'offre collaborative supprimée.

Procédure

Il faut appeler un endpoint permettant de supprimer une offre collaborative d'un dossier client

https://api.cegid.com/loop-api-publiques/collaborativeOffer/removeOffer

Route Méthode http Description
/collaborativeOffer/removeOffer POST Retire l'offre de tous les utilisateurs associés à cette offre

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
codeDossier string Code du dossier dans lequel l'offre collaborative doit être supprimée. Oui
offre string Type d'offre à supprimer du dossier. Les valeurs possibles sont : start, co-production, consultation, cac Oui

Exemple de body

{
  "codeDossier": "CEGID003",
  "offre": "consultation"
}

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
Message string message Oui

Exemple de retour

{
  "message": "L'offre consultation a été retirée du dossier client CEGID003"
}

POST/provisionningCollab/removeApplication

Supprime une offre collaborative d'un dossier client et révoque les droits d'accès au dossier et au SharePoint de l'interlocuteur associé à cette offre pour ce dossier.

Lien vers la documentation technique

Cas d'usage

  • Supprimer une offre collaborative d'un dossier client pour un interlocuteur précis.

  • Révoquer les droits d'accès au dossier et au SharePoint de l'interlocuteur associé à l'offre collaborative supprimée.

Procédure

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

https://api.cegid.com/loop-api-publiques/provisionningCollab/removeApplication

Route Méthode http Description
/provisionningCollab/removeApplication POST supprime une offre collaborative pour un interlocuteur donné

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 Adresse e-mail de l'interlocuteur pour lequel l'offre collaborative doit être supprimée Oui
codeDossier string Code du dossier dans lequel l'offre collaborative doit être supprimée Oui
offre string Type d'offre à supprimer du dossier. Les valeurs possibles sont: start, consultation, co-production, cac Oui

Exemple de body

{
    "email": "nghanem@cegid.com",
    "codeDossier": "nicoletestnew",
    "offre": "start"
}

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
interloc object les informations UID
user object les informations UID

Exemple de retour

{
    "interloc": {
        "module": "cabinet",
        "className": "interlocuteur",
        "data": {
            "objectId": "46515544-dca9-4dc1-a9c7-3f7ee962a6cf",
            "$status": "none",
            "revisionId": "0x000000000038CB52"
        }
    },
    "user": {
        "module": "cabinet",
        "className": "utilisateurClient",
        "data": {
            "objectId": "f1f32fb1-5b59-40a9-8fd2-55530babbded",
            "$status": "none",
            "revisionId": "0x000000000038CB4F"
        }
    }
}

POST/loopHub/getDossiersByApiKey

Récupère la liste des dossiers associés à une clé d'application donnée.

Lien vers la documentation technique

Cas d'usage

  • Récupérer la liste des dossiers associés à une clé d'application donnée. Cela est utile pour pouvoir gérer les dossiers liés à une application spécifique.

Procédure

Il faut appeler un endpoint permettant de recupérer la liste des dossiers associés à une clé d'application donnée

https://api.cegid.com/loop-api-publiques//loopHub/getDossiersByApiKey

Route Méthode http Description
/loopHub/getDossiersByApiKey POST Liste les dossiers associés à une clé d'application donnée

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

Pas de body

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
objectId UID Identifiant unique de l'objet
codeIbs string Code du dossier
nom string Nom
prenom string Prénom
nomUsuel string Nom du dossier
raisonSociale string Raison sociale
maitreDossier string Adresse mail du maître du dossier
maitreDossierId UID Identifiant unique du maître du dossier
engagementManager string Adresse mail de l'engagement manager
engagementManagerId UID Identifiant unique de l'engagement manager
siren string Numéro SIREN de l'entité
email string Adresse email

Exemple de retour

[{
    "objectId": "01107748-1b45-473a-9283-cf5fa52faac2",
    "codeIbs": "CEP2022",
    "nom": "",
    "prenom": "",
    "nomUsuel": "DEVIS FACTURES MB ELEC",
    "raisonSociale": "DEVIS FACTURES MB ELEC",
    "maitreDossier": "fanny.villaud@cegidtomorrow.onmicrosoft.com",
    "maitreDossierId": "6ee43d55-2a21-420f-9ff9-e806924fdf74",
    "engagementManager": "cep22@cegidtomorrow.onmicrosoft.com",
    "engagementManagerId": "5f126819-6816-4686-b0fc-d98d6c1aaf81",
    "siren": "914145016",
    "email": "splaire@cegid.com"
}, 
{
    "objectId": "69fe97d8-2e98-456c-b99e-f35f5514f4d7",
    "codeIbs": "COA2023P",
    "nom": "",
    "prenom": "",
    "nomUsuel": "COA2023P",
    "raisonSociale": "COA2023P",
    "maitreDossier": "pascal.reyboz@cegidtomorrow.onmicrosoft.com",
    "maitreDossierId": "90183e8a-5322-4248-bf64-b5cf3f8eef60",
    "engagementManager": "pascal.reyboz@cegidtomorrow.onmicrosoft.com",
    "engagementManagerId": "90183e8a-5322-4248-bf64-b5cf3f8eef60",
    "siren": "351918719",
    "email": "preyboz@cegid.com"
}, 
{
    "objectId": "51add9bc-358d-4ae7-a3fa-b0605b23455c",
    "codeIbs": "ELEC44",
    "nom": "",
    "prenom": "",
    "nomUsuel": "MB ELEC44",
    "raisonSociale": "MB ELEC44",
    "maitreDossier": "cep22@cegidtomorrow.onmicrosoft.com",
    "maitreDossierId": "5f126819-6816-4686-b0fc-d98d6c1aaf81",
    "engagementManager": "cep22@cegidtomorrow.onmicrosoft.com",
    "engagementManagerId": "5f126819-6816-4686-b0fc-d98d6c1aaf81",
    "siren": "",
    "email": ""
}, 
{
    "objectId": "62fcbb3d-0f73-4991-8f3c-8c01611d74f0",
    "codeIbs": "YAS",
    "nom": "",
    "prenom": "",
    "nomUsuel": "Dossier YAS",
    "raisonSociale": "Dossier YAS",
    "maitreDossier": "cep22@cegidtomorrow.onmicrosoft.com",
    "maitreDossierId": "5f126819-6816-4686-b0fc-d98d6c1aaf81",
    "engagementManager": "cep22@cegidtomorrow.onmicrosoft.com",
    "engagementManagerId": "5f126819-6816-4686-b0fc-d98d6c1aaf81",
    "siren": "",
    "email": ""
}]

POST/companyProvisioning/provisionCompany

Appovisionne la base de données ainsi que la GED pour un dossier client spécifié. Elle vérifie que le dossier respecte les conditions préalables avant de procéder au traitement.

Lien vers la documentation technique

Cas d'usage

  • Approvisionner la base de données et la GED d'un dossier client : Utilisez cette API pour initialiser la base de données ainsi que la GED pour un dossier client spécifique.

  • Vérification des conditions préalables : Assurez-vous que le dossier client fourni dans la requête contient un "maître du dossier" désigné et est au statut "À préparer". Ces conditions sont nécessaires pour que l'approvisionnement puisse être effectué correctement.

Procédure

Il faut appeler un endpoint permettant d'approvisionner la base de données ainsi que la GED d'un dossier client:

https://api.cegid.com/loop-api-publiques/companyProvisioning/provisionCompany

Route Méthode http Description
/provisionCompany POST Approvisionne la base SQL ainsi que la GED d'un dossier client

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
codeDossier string Code du dossier à approvisionner Oui

Exemple de body

{
    "codeDossier": "CEGID003"
}

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
message string message

Exemple de retour

{"message":"Approvisionnement en cours."}

POST/provisionningCollab/addClient

Ajout d'un nouvel interlocuteur et attribution d'une offre collaborative à un dossier spécifique.

Lien vers la documentation technique

Cas d'usage

  • Créer un nouvel interlocuteur et attribuer une offre collaborative : Utilisez cette API pour ajouter un nouvel interlocuteur dans le système et lui associer une offre collaborative spécifique à un dossier donné.

  • Avant de pouvoir proposer un service à cet interlocuteur, il est impératif de l'inviter d'abord sur votre tenant. Vous pouvez, par exemple, l'inviter sur l'équipe Teams du dossier concerné.

  • Condition d'activation de l'offre : Si l'offre que vous souhaitez inclure dans le corps de la requête n'est pas déjà activée pour le dossier concerné pour un autre interlocuteur, le nouvel interlocuteur ne sera pas créé. Assurez-vous que l'offre est active dans le dossier avant de faire la requête pour ajouter un nouvel interlocuteur.

Procédure

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

https://api.cegid.com/loop-api-publiques/provisionningCollab/addClient

Route Méthode http Description
/provisionningCollab/addClient POST Ajout d'un interlocuteur et attribution d'une offre collaborative au dossier

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 Adresse email de l'interlocuteur à ajouter Oui
codeDossier string Code du dossier auquel l'offre doit être associée Oui
offre string Offre collaborative à associer Oui
nom string Nom de l'interlocuteur Non
prenom string Prénom de l'interlocuteur Non
telephone string Numéro de téléphone de l'interlocuteur Non
profile string Profil de l'interlocuteur (valeurs possibles : 1.0 par défaut, 2.0, 2.5 pour les offres CAC) Non
social boolean Indicateur d'accès aux fonctionnalités sociales Non

Exemple de body

{
    "email": "nicole@hotmail.com",
    "codeDossier": "dossiertest",
    "offre": "start",
    "nom": "nicolenom",
    "prenom": "nicole",
    "telephone": "03 12 34 56 77",
    "profile": "1.0",
    "social": 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
interloc object les informations UID

Exemple de retour

{
    "interloc": {
        "module": "cabinet",
        "className": "interlocuteur",
        "data": {
            "objectId": "062d8c9a-6a5b-442e-b250-a4170838fab9",
            "$status": "none",
            "revisionId": "0x000000000037D149"
        }
    }
}

Note:

Nous recommandons de privilégier les nouvelles APIs ci-dessous, au lieu des méthodes précédentes, car elles offrent une approche plus simple et plus performante pour gérer les interlocuteurs et les offres collaboratives.

API createInterlocutor : Pour créer un nouvel interlocuteur. Cette API simplifie le processus de création et est plus efficace.

API AddCollaborativeOffer : Pour attribuer une offre collaborative à un interlocuteur. Elle offre une méthode plus directe et simplifiée pour activer les offres.

POST/provisionningCollab/updateClient

Modifie les informations d'un interlocuteur et met à jour les détails de l'utilisateur client associé.

Lien vers la documentation technique

Cas d'usage

  • Mettre à jour l'interlocuteur en lui ajoutant une offre collaborative sur un dossier. Si l'offre collaborative qu'on désire ajouter n'est pas déjà activée pour d'autres interlocuteurs sur ce dossier, l'offre ne sera pas activée.

  • Mettre à jour les détails de l'interlocuteur : Si l'offre collaborative mentionnée est déjà activée ou peut l'être, vous pouvez modifier les informations personnelles de l'interlocuteur (nom, prénom, adresse email, numéro de téléphone), ainsi que les attributs spécifiques tels que l'accès aux fonctionnalités sociales, l'état actif de l'interlocuteur, le statut du compte Microsoft (personnel ou professionnel) et le rôle organisationnel.

Procédure

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

https://api.cegid.com/loop-api-publiques/provisionningCollab/updateClient

Route Méthode http Description
/provisionningCollab/updateClient POST Modification d'un interlocuteur

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 Adresse email de l'interlocuteur Oui
codeDossier string Code du dossier Oui
offre string Type d'offre à ajouter au dossier. Les valeurs possibles sont: start, consultation, co-production, cac Oui
nom string Nom de l'interlocuteur Non
prenom string Prénom de l'interlocuteur Non
telephone string Numéro de téléphone de l'interlocuteur Non
profile string Profil de l'interlocuteur (valeurs possibles : 1.0 par défaut, 2.0, 2.5 pour les offres CAC) Non
social boolean Indicateur d'accès aux fonctionnalités sociales Non
actif boolean Indicateur si le compte de l'interlocuteur est actif Non
defaultIssuer boolean Indicateur si l'interlocuteur est un compte personnel Microsoft (par défaut) Non

Exemple de body

{
    "email": "nicole12345678@hotmail.com",
    "codeDossier": "12345",
    "offre": "consultation",
    "nom": "nicolenew",
    "prenom":"nicole",
    "telephone": "03 33 34 56 77",
    "profile": "2.0",
    "social": false,
    "actif": false,
    "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
interloc object les informations UID
user object les informations UID

Exemple de retour

{
    "interloc": {
        "module": "cabinet",
        "className": "interlocuteur",
        "data": {
            "objectId": "1888e3bc-e74b-4220-8073-9512a6aa9098",
            "$status": "none",
            "revisionId": "0x000000000038AC73"
        }
    },
    "user": {
        "module": "cabinet",
        "className": "utilisateurClient",
        "data": {
            "objectId": "dde3f87d-f9c2-49a9-93f8-1c9e7e4a6b64",
            "$status": "none",
            "revisionId": "0x000000000038AC76"
        }
    }
}