Loop API Standard

General presentation

These APIs allow partners to activate or deactivate the Cegid Loop APIs Standard application on company files, and to track the progress of the operation using a jobId.

They require an APIKey Standard (P04448).

• Activate the application
• Deactivate the application
• Get progress status

Workflow

1. Call activateStandardAPI or deactivateStandardAPI.
2. Save the jobId returned in the response.
3. Poll getStandardAPIProgressStatus with the jobId until status is completed or failed (success + failed = total).
4. Job records are kept (no TTL). 404 means the jobId is unknown.

For up to 50 company files, processing may complete synchronously and the response can already include total, success, failed, details, and status. For all company files or more than 50 files, processing is asynchronous: the response contains jobId, message, and type only.

POST /activateStandardAPI

Activate the Cegid Loop APIs Standard application on selected company files.

Technical documentation on Cegid Developers

Request

Headers

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

Body

Field	Type	Description	Required
apiKey	string	API Key identifier (key part)	Yes
codeSIC	string	SIC code of the accounting practice	Yes
companyFiles	array of string	Company file codes (codeIbs)	No*
allCompanyFiles	boolean	Activate on all company files	No*

* Either allCompanyFiles must be true, or companyFiles must contain at least one code. If allCompanyFiles is true, companyFiles must be empty or omitted.

Example (specific company files)

{
  "apiKey": "your-api-key-id",
  "codeSIC": "12345",
  "companyFiles": ["CEGID001", "CEGID002"],
  "allCompanyFiles": false
}

Example (all company files)

{
  "apiKey": "your-api-key-id",
  "codeSIC": "12345",
  "allCompanyFiles": true
}

Response

Async example

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

Sync example (small scope)

{
  "jobId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "total": 2,
  "success": 2,
  "failed": 0,
  "details": [
    { "codeIbs": "CEGID001", "status": "success" },
    { "codeIbs": "CEGID002", "status": "success" }
  ],
  "type": "addApplicationAndWorkGroupToDossier"
}

POST /deactivateStandardAPI

Deactivate the Cegid Loop APIs Standard application from selected company files.

Technical documentation on Cegid Developers

Request

Headers

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

Body

Field	Type	Description	Required
companyFiles	array of string	Company file codes (codeIbs)	No*
allCompanyFiles	boolean	Deactivate from all company files	No*

* Same rules as for activation.

Example

{
  "companyFiles": ["CEGID001"],
  "allCompanyFiles": false
}

Response

Same structure as activation. type is removeApplicationAndWorkGroupFromDossier.

GET /getStandardAPIProgressStatus

Returns the progress of an activation or deactivation job.

Technical documentation on Cegid Developers

Request

Headers

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

Query parameters

Field	Type	Description	Required
jobId	string	Job identifier from activate/deactivate response	Yes

Example

GET /getStandardAPIProgressStatus?jobId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Response

{
  "total": 10,
  "success": 8,
  "failed": 2,
  "details": [
    { "codeIbs": "CEGID001", "status": "success" },
    { "codeIbs": "CEGID002", "status": "failed", "reason": "Dossier not found" }
  ],
  "type": "addApplicationAndWorkGroupToDossier",
  "status": "failed"
}

status is inProgress while dossiers are still being processed, completed when every dossier succeeded, and failed when the job is finished with at least one dossier failure (including max retries exhausted). Poll until status is completed or failed.

Errors

HTTP code	Description
404	Job not found

For other errors, see Error handling.