Activer l'application Cegid Loop APIs Standard

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

Cette API permet d'activer l'application Cegid Loop APIs Standard pour un ou plusieurs dossiers clients du cabinet. Elle retourne un identifiant de tâche (jobId) pour suivre l'avancement.

POST/activateStandardAPI

Cette API active l'application Cegid Loop APIs Standard sur les dossiers demandés.

Lien vers la documentation technique

Cas d'usage

Cette API permet d'activer l'application Cegid Loop APIs Standard sur une sélection de dossiers clients.
Elle permet également d'activer l'application sur l'ensemble des dossiers du cabinet grâce au paramètre allCompanyFiles.
Pour suivre l'avancement, conserver le jobId et interroger getStandardAPIProgressStatus.

Procédure

Appeler l'endpoint d'activation.
Enregistrer le jobId retourné.
Interroger GET /getStandardAPIProgressStatus jusqu'à ce que status vaille completed ou failed.

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

Route	Méthode http	Description
/activateStandardAPI	POST	Active l'application Cegid Loop APIs Standard et retourne un jobId

Jusqu'à 50 dossiers, le traitement peut être synchrone : la réponse contient déjà total, success, failed, details et status. Pour tous les dossiers (allCompanyFiles à true) ou plus de 50 dossiers, le traitement est asynchrone : la réponse contient jobId, message et type.

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
apiKey	string	Clé d'API de l'application à activer	Oui
codeSIC	string	Code SIC du cabinet	Oui
companyFiles	array of string	Liste des codes des dossiers clients sur lesquels activer l'application	Non*
allCompanyFiles	boolean	Active l'application sur l'ensemble des dossiers du cabinet	Non*

* Soit allCompanyFiles est true, soit companyFiles contient au moins un code. Si allCompanyFiles est true, companyFiles doit être vide ou omis.

Exemple de body (sélection de dossiers)

{
    "apiKey": "my_secret_api_key",
    "codeSIC": "CEGID001",
    "companyFiles": ["dossier1", "dossier2"],
    "allCompanyFiles": false
}

Exemple de body (tous les dossiers)

{
    "apiKey": "my_secret_api_key",
    "codeSIC": "CEGID001",
    "allCompanyFiles": true
}

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

La réponse contient toujours un jobId. Selon le périmètre, le détail par dossier peut être présent immédiatement (synchrone) ou uniquement via getStandardAPIProgressStatus (asynchrone).

Champ	Type	Description
jobId	string	Identifiant de tâche à utiliser avec getStandardAPIProgressStatus
message	string	Message lorsque le traitement est asynchrone
type	string	`addApplicationAndWorkGroupToDossier`
total	integer	Nombre total de dossiers (réponse synchrone)
success	integer	Nombre de dossiers activés avec succès (réponse synchrone)
failed	integer	Nombre de dossiers en échec (réponse synchrone)
details	array	Détail du résultat par dossier (réponse synchrone)
details[].codeIbs	string	Code du dossier
details[].status	string	`success` ou `failed`
details[].reason	string	Raison de l'échec, le cas échéant
status	string	`inProgress`, `completed` ou `failed` (réponse synchrone)

Exemple de retour asynchrone

{
    "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "message": "Request to activate the application has been accepted.",
    "type": "addApplicationAndWorkGroupToDossier"
}

Exemple de retour synchrone (petit périmètre)

{
    "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "total": 2,
    "success": 1,
    "failed": 1,
    "details": [
        {
            "codeIbs": "dossier1",
            "status": "success"
        },
        {
            "codeIbs": "dossier2",
            "status": "failed",
            "reason": "Dossier introuvable"
        }
    ],
    "type": "addApplicationAndWorkGroupToDossier",
    "status": "failed"
}

Table of Contents