API docs by Redocly

OnboardingApi (1.1.3)

License: Copyright

API permettant de gérer des campagnes d'affiliations.

Liste des erreurs

Voici la liste des codes d'erreur internes, ces erreurs n'apparaissent que dans le cadre d'un statut HTTP 500.

Code Statut HTTP
ONB-1 500
ONB-11 500
ONB-17 500

Voici la liste des codes d'erreur

Code Description Statut HTTP
ONB-2 La paramètre external_reference est déjà utilisé 400
ONB-3 Le status du dossier ne permet pas cette action 400
ONB-4 Pas de fichier enregistré 404
ONB-5 Aucune campagne trouvé 404
ONB-6 Aucune dossier trouvé 404
ONB-7 Aucune file trouvé 404
ONB-8 Aucun model trouvé 404
ONB-9 Chemin invalide 404
ONB-10 Un paramètre est manquant ou invalide dans le corps de la requête (ex: paramètre envoyé en string au lieu d'un integer) 422
ONB-12 Token manquant 401
ONB-13 Signature du token invalide 400
ONB-15 Token expiré 400
ONB-15 Token invalide 400
ONB-16 Accès non authorisé au service (token invalide) 403

Ouvrir un dossier d'affiliation

Ouvre un dossier d'affiliation en utilisant une référence externe comme clé unique.

Authorizations:
BearerToken
path Parameters
campaign_name
string

La référence de la campagne

external_reference
string

La référence externe du dossier

Request Body schema: multipart/form-data
file_name
file <binary>
Array of objects

Responses

Response samples

Content type
application/json
{
  • "campaign_name": "string",
  • "external_ref": "string",
  • "status": "OPENED",
  • "signed_at": "string",
  • "files": [
    ]
}

Ajoute des documents et des méta-datas à un dossier d'affiliation

Ajoute des documents et des méta-datas à un dossier d'affiliation déjà existant.

Authorizations:
BearerToken
path Parameters
campaign_name
string

La référence de la campagne

external_reference
string

La référence externe du dossier

Request Body schema: multipart/form-data
file_name
file <binary>
Array of objects

Responses

Response samples

Content type
application/json
{
  • "campaign_name": "string",
  • "external_ref": "string",
  • "status": "OPENED",
  • "signed_at": "string",
  • "files": [
    ]
}

Récupérer le dossier d'affiliation

Récupérer les informations du dossier d'affiliation.

Authorizations:
BearerToken
path Parameters
campaign_name
string

La référence de la campagne

external_reference
string

La référence externe du dossier

Responses

Response samples

Content type
application/json
{
  • "campaign_name": "string",
  • "external_ref": "string",
  • "status": "OPENED",
  • "signed_at": "string",
  • "files": [
    ]
}

Récupérer le fichier

Télécharge un fichier du dossier d'affiliation via son identifiant

Authorizations:
BearerToken
path Parameters
campaign_name
string

La référence de la campagne

external_reference
string

La référence externe du dossier

identifier
string

Identififiant du fichier

Responses

Response samples

Content type
application/json
"string"

Récupérer les dossiers

Récupère les dossiers depuis soit la date de signature soit la date de création

Authorizations:
BearerToken
path Parameters
campaign_name
string

La référence de la campagne

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
[
  • {
    }
]

Mettre à jour le statut d'un dossier

Met à jour le statut d'un dossier pour une campagne spécifique.

Authorizations:
BearerToken
path Parameters
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

Request Body schema: application/json
required

Données de la requête pour mettre à jour le statut

status
string

Le nouveau statut à appliquer au dossier

Responses

Request samples

Content type
application/json
{
  • "status": "COMPLETED"
}

Response samples

Content type
application/json
{
  • "campaign_name": "string",
  • "external_ref": "string",
  • "status": "OPENED",
  • "signed_at": "string",
  • "files": [
    ]
}

Récupérer les usages de l'api.

Récupérer les usages de l'api.

Authorizations:
BearerToken
Request Body schema: application/json
required
startDate
string <Y-m-d>

La date à partir de laquelle les usages seront récupérés

endDate
string <Y-m-d>

La date de fin pour laquelle les usages seront récupérés

Responses

Request samples

Content type
application/json
{
  • "startDate": "2020-06-14",
  • "endDate": "2021-01-01"
}

Response samples

Content type
application/json
{
  • "api": "onboarding",
  • "startDate": "2020-06-14",
  • "endDate": "2021-01-01",
  • "clients": [
    ]
}