Comment accéder à l’API

Enregistrez une application dans le Back Office de B2CORE IB, choisissez son niveau d’accès, échangez ses identifiants contre un jeton d’accès et appelez l’API IB

Les intégrations accèdent à l’API B2CORE IB pour le compte d’une application enregistrée dans le Back Office. Chaque application possède un ID client, un secret client et un niveau d’accès qui détermine si elle peut modifier des données. Cet article explique comment enregistrer une application et effectuer votre premier appel à l’API.

Enregistrer une application

Accédez à Courtiers introducteurs > Préférences > Applications.

Cliquez sur Enregistrer une nouvelle application.

Saisissez un nom dans le champ Nom de l’application.

Sélectionnez le Niveau d’accès :

  • Read-only (présélectionné) — l’application peut appeler toutes les opérations GET et créer des tâches d’exportation ; toute autre requête POST, PUT, PATCH ou DELETE effectuée avec son jeton d’accès est rejetée. Recommandé pour les intégrations de reporting et de surveillance.
  • Full access — l’application peut appeler toutes les opérations de l’API.

Vous pouvez modifier le niveau d’accès ultérieurement sur la page de détails de l’application. La modification s’applique à la prochaine requête API de l’application.

Cliquez sur Enregistrer.

Vous êtes redirigé vers la page de détails de la nouvelle application, où vous pouvez consulter le Nom de l’application, l’ID client, le Secret client, le Niveau d’accès et la Liste blanche d’adresses IP.

Copiez votre ID client et votre secret client, puis conservez-les dans un espace de stockage sécurisé. Ils servent à vérifier votre identité lorsque vous accédez à l’API. Le secret client n’est affiché qu’une seule fois, sur cette page : vous ne pourrez plus le consulter par la suite.

Obtenir un jeton d’accès

Envoyez une requête POST à l’opération /tokens en utilisant l’authentification HTTP Basic, avec l’ID client comme nom d’utilisateur et le secret client comme mot de passe :

curl -X POST "{baseUrl}/tokens" \
  -u "CLIENT_ID:CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"grant_type": "client_credentials"}'

Remplacez {baseUrl} par l’URL de base de votre API IB, fournie par votre équipe d’intégration B2BROKER.

Copiez la valeur access_token de la réponse. Celle-ci contient également token_type (Bearer) et expires_in — la durée de validité du jeton en secondes. La demande d’un nouveau jeton révoque les jetons précédents de l’application.

Appeler l’API

Transmettez le jeton dans l’en-tête Authorization de chaque requête :

curl "{baseUrl}/users" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Toutes les opérations figurent dans la référence de l’API. Chaque opération indique l’accès requis : read (accessible à toutes les applications) ou write (réservé aux applications disposant d’un accès complet).

Que signifie une réponse 403 ?

Si une application en lecture seule appelle une opération nécessitant l’accès write, l’API rejette la requête avec le code HTTP 403 et le corps de réponse suivant :

{
  "error": {
    "message": "This App is read-only and cannot perform this operation.",
    "code": "insufficient_scope"
  }
}

Vérifiez le champ code : insufficient_scope signifie que le niveau d’accès de l’application est en cause. Pour que la requête aboutisse, passez l’application en Full access dans Courtiers introducteurs > Préférences > Applications — la modification s’applique dès la prochaine requête, sans qu’un nouveau jeton soit nécessaire — ou enregistrez une application distincte avec un accès complet pour l’intégration qui doit modifier des données.

La seule exception est POST /exports/async : la création d’une tâche d’exportation est autorisée pour les applications en lecture seule. Les intégrations de reporting peuvent ainsi exporter des données sans accès complet.

Dernière mise à jour le

Sur cette page