Here is the list of internal error codes, these errors only appear with an HTTP 500 status.
| Code | HTTP Status |
|---|---|
| ONB-1 | 500 |
| ONB-11 | 500 |
| ONB-17 | 500 |
Here is the list of error codes
| Code | Description | HTTP Status |
|---|---|---|
| ONB-2 | The external_reference parameter is already used | 400 |
| ONB-3 | The folder status does not allow this action | 400 |
| ONB-4 | No file saved | 404 |
| ONB-5 | Campaign not found | 404 |
| ONB-6 | Folder not found | 404 |
| ONB-7 | File not found | 404 |
| ONB-8 | Model not found | 404 |
| ONB-9 | Invalid route | 404 |
| ONB-10 | A parameter is missing or invalid in the request body (e.g., parameter sent as string instead of an integer) | 422 |
| ONB-12 | Missing token | 401 |
| ONB-13 | Invalid token signature | 400 |
| ONB-14 | Expired token | 400 |
| ONB-15 | Invalid token | 400 |
| ONB-16 | Unauthorized access to service (invalid token) | 403 |
| ONB-23 | Rate limit exceeded | 429 |
The API supports response localization based on the Accept-Language HTTP header.
Supported locales: fr, en. Defaults to fr if the header is absent or contains an unsupported locale.
All routes are subject to a rate limit (requests per minute). When the limit is exceeded, the API returns an HTTP 429 with error code ONB-23.
The response includes the following headers:
X-RateLimit-Limit: maximum number of requests allowed per minuteX-RateLimit-Remaining: number of requests remaining in the current windowRetry-After: seconds to wait before retryingGet API usages for a given period
| start_date required | string <date> Example: start_date=2024-01-01 |
| end_date required | string <date> Example: end_date=2024-01-31 |
| Accept-Language | string Example: fr Locale for response messages. Supported: |
{- "api": "onboarding",
- "startDate": "2020-06-14",
- "endDate": "2021-01-01",
- "clients": [
- {
- "clientId": "string",
- "products": [
- {
- "product": "string",
- "label": "string",
- "quantities": 0
}
]
}
]
}Ouvre un dossier d'affiliation en utilisant une référence externe comme clé unique.
| campaign_name required | string La référence de la campagne |
| external_reference required | string La référence externe du dossier |
| file_name | file <binary> |
Array of objects |
{- "campaign_name": "string",
- "external_ref": "string",
- "status": "OPENED",
- "signed_at": "string",
- "files": [
- {
- "identifier": "string",
- "name": "string",
- "metadatas": {
- "property1": "string",
- "property2": "string"
}, - "link": "string"
}
]
}Ajoute des documents et des méta-datas à un dossier d'affiliation déjà existant.
| campaign_name required | string La référence de la campagne |
| external_reference required | string La référence externe du dossier |
| file_name | file <binary> |
Array of objects |
{- "campaign_name": "string",
- "external_ref": "string",
- "status": "OPENED",
- "signed_at": "string",
- "files": [
- {
- "identifier": "string",
- "name": "string",
- "metadatas": {
- "property1": "string",
- "property2": "string"
}, - "link": "string"
}
]
}Récupérer les informations du dossier d'affiliation.
| campaign_name required | string La référence de la campagne |
| external_reference required | string La référence externe du dossier |
{- "campaign_name": "string",
- "external_ref": "string",
- "status": "OPENED",
- "signed_at": "string",
- "files": [
- {
- "identifier": "string",
- "name": "string",
- "metadatas": {
- "property1": "string",
- "property2": "string"
}, - "link": "string"
}
]
}Télécharge un fichier du dossier d'affiliation via son identifiant
| campaign_name required | string La référence de la campagne |
| external_reference required | string La référence externe du dossier |
| identifier required | string Identififiant du fichier |
"string"Récupère les dossiers depuis soit la date de signature soit la date de création
| campaign_name required | string La référence de la campagne |
| signed_since | string <Y-m-dTH:i:sP> On récupère les dossiers signés depuis cette date (à renseigner pour récupérer les dossier en status SIGNED) |
| created_since | string <Y-m-dTH:i:sP> On récupère les dossiers depuis cette date par rapport à la date de création (à renseigner pour récupérer les dossier en status OPENED) |
| status | string Default: "SIGNED" Enum: "OPENED" "SIGNED" Le status des dossiers que l'on veut récupérer. Si le status n'est pas renseigné, le status SIGNED est utilisé par défaut |
{- "signed_since": "2013-06-14T04:00:36-03:00",
- "created_since": "2013-06-14T04:00:36-03:00",
- "status": "2013-06-14T04:00:36-03:00"
}[- {
- "campaign_name": "string",
- "external_ref": "string",
- "status": "OPENED",
- "signed_at": "string",
- "files": [
- {
- "identifier": "string",
- "name": "string",
- "metadatas": {
- "property1": "string",
- "property2": "string"
}, - "link": "string"
}
]
}
]Met à jour le statut d'un dossier pour une campagne spécifique.
| campaign_name required | string Example: SRD L'identifiant de référence de la campagne |
| external_reference required | string Example: SRD0010 La référence externe du dossier |
Données de la requête pour mettre à jour le statut
| status | string Le nouveau statut à appliquer au dossier |
{- "status": "COMPLETED"
}{- "campaign_name": "string",
- "external_ref": "string",
- "status": "OPENED",
- "signed_at": "string",
- "files": [
- {
- "identifier": "string",
- "name": "string",
- "metadatas": {
- "property1": "string",
- "property2": "string"
}, - "link": "string"
}
]
}