API d'authentification d'application
Commencer
L’authentification de l’application est une authentification basée sur des jetons oAuth 2.0. Un ensemble d’identifiants est créé pour chaque DSP dans chaque environnement.
❗ ❗ Lors du démarrage d’un travail sur une API DCP, nous devons demander l’accès en créant un ticket de certification dans Jira, comme décrit dans la section Activités de Certification avec Jira. ❗ ❗
Si vous avez déjà commencé à travailler sur une API et que vous avez perdu l’accès, créez un ticket de support comme décrit dans la section Ouvrir un Ticket de Support.
Les identifiants n’expirent normalement jamais et ne sont jamais révoqués (sauf si vous quittez DCP).
Cependant, les identifiants peuvent changer, donc votre implémentation doit vous permettre de changer et d’utiliser facilement de nouveaux identifiants.
Le jeton d'accès est valable pendant 30 minutes ! (1799 secondes)
Par où commencer ? À lire en premier !
Avant de commencer à travailler sur cette API, vous devez lire les sections suivantes si vous ne les avez pas déjà consultées :
- Informations techniques pour des informations techniques générales sur l'API et les environnements.
- Authentification et informations d’identification pour des détails sur l'authentification et les identifiants.
Informations techniques
Caractéristiques
Type d'API | Type DSP | Version DCP | Complexité |
|---|---|---|---|
Obtenir des données de BRP | DMS | V3 - International | Faible |
Envoyer des données à BRP | CRM | V4 - Amérique du Nord | Un peu plus |
Transaction avec BRP | | | Un peu plus |
Authentification
Pour appeler l'API d'authentification d'application, vous avez besoin du client_id et client_secret fournis par l'équipe DCP.
Assurez-vous d'utiliser le client_id et client_secret afin de correspondre à l'environnement dans lequel l'API est appelée !
URL de base
Test | https://qa-cloud-api.brp.com/dcp |
|---|---|
Production | https://cloud-api.brp.com/dcp |
Référence API
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=REPLACE_ME_CLIENT_ID' \
--data-urlencode 'client_secret=REPLACE_ME_CLIENT_SECRET'curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/verify' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw ''Comment faire
Cette section fournit des informations sur la manière d’obtenir des résultats spécifiques avec l’API.
Obtenir un jeton d’accès
Remplacez le REPLACE_ME_CLIENT_ID et REPLACE_ME_CLIENT_SECRET par les valeurs correspondant à vos identifiants dans l’environnement où l’appel est effectué.
Si les identifiants REPLACE_ME_CLIENT_ID et REPLACE_ME_CLIENT_SECRET sont valides, la réponse vous fournira un access_token.
Le jeton d’accès est valable pendant 30 minutes ! (1799 secondes)
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=REPLACE_ME_CLIENT_ID' \
--data-urlencode 'client_secret=REPLACE_ME_CLIENT_SECRET'Vérifier un jeton d’accès
Après avoir obtenu votre jeton Bearer access_token, vous pouvez le vérifier en appelant le point de terminaison API verify.
La réponse de l’API fournira le nom de l’application si le jeton est valide et non expiré.
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/verify' \
--header 'Authorization: Bearer REPLACE_ME_ACCESS_TOKEN' \
--data-raw ''Gestion des erreurs
Cette section présente divers scénarios d’appels incorrects ou erronés, qui entraînent des messages d’erreur et des résultats incorrects.
400 Requête incorrecte
La valeur grant_type est invalide ou manquante.
Vérifiez votre appel et assurez-vous d’inclure le grant_type approprié.
401 Non autorisé
Le code d’état 401 Unauthorized est généralement causé par un client_id ou un client_secret non valide.
Une autre raison possible est qu’un paramètre de requête est manquant.
Pour résoudre ce problème, vérifiez que vous utilisez l’ensemble d’identifiants approprié pour l’environnement dans lequel vous appelez l’API DCP.
Reportez-vous à la section Environnements pour obtenir des informations sur les environnements disponibles.
Exigences DSP
Exigences fonctionnelles
ID | Type | |
|---|---|---|
1 | Obligatoire | Le access_token doit être automatiquement actualisé toutes les 29 minutes |
Activités de certification
Il n’y a pas d’activités de certification spécifiques pour l’API d’authentification des applications ; elle est validée via l’API DCP en utilisant l’authentification des applications.
Postman
Cette section décrit ce qui est disponible dans Postman pour explorer l’API.
Environnements
Un environnement Postman est disponible pour tester l’API d’authentification des applications. Cet environnement Postman contient des variables utilisées par les requêtes et est configuré pour se connecter à l’environnement de test.
Collections
La collection DSP - Authentification des applications contient des exemples d’appels à l’API pour obtenir un jeton d’accès et valider ce jeton.