Les développeurs recherchent souvent des moyens efficaces d'intégrer des services financiers dans leurs applications, et l'API Brex se distingue comme une solution robuste pour gérer les limites de dépenses, les transactions et les ressources d'équipe. Cet article vous guide à travers le processus d'accès et d'utilisation de l'API Brex. Vous apprendrez comment configurer l'authentification, explorer les points de terminaison et intégrer l'API dans vos systèmes.
Au fur et à mesure que vous avancez, n'oubliez pas que de petits ajustements dans votre approche, comme le choix des bons scopes lors de la génération de jetons, peuvent avoir un impact significatif sur le succès de l'intégration. Par conséquent, portez une attention particulière à chaque étape pour garantir une connectivité fluide.
Qu'est-ce que l'API Brex ?
L'API Brex fournit une interface RESTful qui permet aux développeurs d'automatiser et de personnaliser les flux de travail financiers au sein de la plateforme Brex. Brex, une entreprise de technologie financière, propose des services tels que des cartes d'entreprise, la gestion des dépenses et le suivi des frais. Par conséquent, l'API Brex vous permet d'interagir avec ces fonctionnalités de manière programmatique.
L'API Brex comprend plusieurs API spécialisées, telles que l'API Équipe pour la gestion des utilisateurs et des cartes, l'API Transactions pour la récupération des transactions réglées, et l'API Onboarding pour la gestion des parrainages. Chacune d'elles répond à différents aspects de la gestion financière, vous permettant de créer des rapports personnalisés, d'automatiser les invitations d'utilisateurs ou de suivre les dépenses en temps réel.
De plus, Brex met l'accent sur la sécurité et la conformité, garantissant que les interactions API sont alignées sur les normes de l'industrie. Par conséquent, lorsque vous utilisez l'API Brex, vous avez accès à des outils qui prennent en charge des opérations financières évolutives sans compromettre l'intégrité des données.
Pourquoi devriez-vous utiliser l'API Brex ?
Vous devriez utiliser l'API Brex si votre application nécessite une intégration avec des outils financiers d'entreprise. Par exemple, les équipes financières ont souvent besoin de synchroniser les données de transaction avec un logiciel de comptabilité, et l'API Brex facilite cela en fournissant des points de terminaison pour lister les transactions et les comptes.
De plus, l'API réduit les efforts manuels de gestion des limites de dépenses et de l'accès des utilisateurs. Vous pouvez automatiser la création de cartes, définir des limites mensuelles et surveiller les activités, ce qui rationalise les opérations pour les entreprises en croissance. De plus, les partenaires en comptabilité ou en RH peuvent exploiter l'API Onboarding pour créer des liens de parrainage personnalisés, améliorant ainsi les processus d'acquisition de clients.
Cependant, sa véritable valeur réside dans sa flexibilité. Vous intégrez l'API Brex aux systèmes existants pour créer des tableaux de bord ou des alertes personnalisés, garantissant que les données financières circulent efficacement entre les plateformes. En conséquence, les développeurs économisent du temps et réduisent les erreurs par rapport à la saisie manuelle des données.
Comment démarrer avec l'accès à l'API Brex ?
Pour commencer avec l'accès à l'API Brex, vous devez d'abord créer un compte Brex si vous n'en avez pas. Visitez brex.com et créez un compte en tant qu'administrateur, car seuls les administrateurs de compte ou les administrateurs de carte peuvent générer des jetons API.
Ensuite, connectez-vous au tableau de bord Brex.
Accédez à la section Développeur sous Paramètres. Ici, vous cliquez sur Créer un jeton pour démarrer le processus. Vous donnez un nom au jeton, ce qui aide à identifier son objectif plus tard, tel que "Jeton d'intégration pour l'application".
De plus, vous sélectionnez les scopes appropriés à cette étape. Les scopes définissent les niveaux d'accès aux données, tels que l'accès en lecture aux transactions ou les permissions d'écriture pour la gestion des utilisateurs. Après avoir confirmé vos sélections, vous cliquez sur Autoriser l'accès, et le système génère le jeton.
Il est important de copier et de stocker ce jeton en toute sécurité immédiatement, car Brex l'obfusque après sa création pour des raisons de sécurité. Si vous le perdez, il vous suffit d'en créer un nouveau. Les jetons expirent après 90 jours d'inactivité, vous devez donc surveiller leur utilisation pour éviter les interruptions.
Une fois que vous avez le jeton, vous testez la connectivité de base. Par exemple, vous utilisez un outil comme curl pour effectuer une simple requête GET vers un point de terminaison, en incluant le jeton dans l'en-tête d'autorisation. Cela vérifie que votre configuration fonctionne correctement.
Comment s'authentifier avec l'API Brex ?
Vous vous authentifiez auprès de l'API Brex en utilisant des jetons d'authentification (bearer tokens). Plus précisément, vous incluez le jeton dans l'en-tête d'autorisation de chaque requête, formaté comme "Bearer {votre_jeton}".
Par exemple, considérez cet exemple curl :
curl -X GET https://platform.brexapis.com/v2/users/me \
-H "Authorization: Bearer bxt_jBWQLZXtu1f4sVT6UjaWPp7Gh9nVGjzEZgRX"
Cette requête récupère les détails de l'utilisateur actuel. En cas de succès, elle renvoie des données JSON sur l'utilisateur.
De plus, Brex prend en charge les jetons utilisateur, qui sont liés à des privilèges d'administrateur spécifiques. Vous générez ces jetons comme décrit précédemment, en vous assurant de choisir des scopes qui correspondent à vos besoins. Par exemple, si vous prévoyez de gérer des cartes, sélectionnez les scopes de lecture et d'écriture sur les points de terminaison des cartes.
Cependant, si un jeton est compromis, révoquez-le immédiatement depuis la page Développeur du tableau de bord. Les jetons révoqués entraînent l'échec des appels API ultérieurs avec une erreur 401, protégeant ainsi votre compte.
En pratique, vous implémentez la gestion des jetons dans le code de votre application. Des bibliothèques comme le module requests de Python simplifient cela :
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
response = requests.get('https://platform.brexapis.com/v2/users/me', headers=headers)
print(response.json())
Cet extrait de code démontre une authentification active dans un script.
Quels sont les points de terminaison clés de l'API Brex ?
L'API Brex propose divers points de terminaison à travers plusieurs API. Vous commencez par explorer l'API Équipe, qui gère les utilisateurs, les départements, les emplacements, les cartes, et plus encore.
- Pour les utilisateurs, vous listez tous les utilisateurs avec GET /v2/users, en filtrant par e-mail ou ID. Les paramètres incluent cursor pour la pagination et limit pour contrôler la taille de la réponse. De même, vous invitez un nouvel utilisateur via POST /v2/users, en fournissant first_name, last_name, email et manager_id facultatif.
De plus, vous mettez à jour les utilisateurs avec PUT /v2/users/{id}, en changeant le statut en ACTIVE ou DISABLED. Vous définissez également des limites mensuelles en utilisant POST /v2/users/{id}/limit, en spécifiant le montant dans le corps de la requête.
- Pour les départements, vous en créez un avec POST /v2/departments, qui nécessite un nom. Vous les listez via GET /v2/departments et récupérez des détails spécifiques avec GET /v2/departments/{id}.
- Les emplacements suivent un schéma similaire : POST /v2/locations pour la création, GET /v2/locations pour la liste.
- Les titres, qui représentent les rôles professionnels, utilisent des points de terminaison comme POST /v2/titles et GET /v2/titles/{id}.
- Les cartes constituent un élément central. Vous listez les cartes avec GET /v2/cards, filtrées par user_id. Pour créer une carte, POST /v2/cards avec des détails comme owner, card_type (VIRTUAL ou PHYSICAL) et spend_controls. Les spend_controls incluent limit_type et amounts.
De plus, vous mettez à jour les cartes via PUT /v2/cards/{id}, les verrouillez avec POST /v2/cards/{id}/lock (en fournissant une raison comme FRAUD), ou les résiliez avec POST /v2/cards/{id}/terminate.
- Les opérations sensibles incluent GET /v2/cards/{id}/pan pour les numéros de carte et POST /v2/cards/{id}/secure_email pour envoyer les détails en toute sécurité.
- Les entités légales et les entreprises ont des points de terminaison en lecture seule comme GET /v2/legal_entities et GET /v2/company.
- Passant à l'API Transactions, vous récupérez les transactions de carte réglées avec GET /v2/transactions/card/primary, en utilisant des paramètres comme posted_at_start pour le filtrage par date. Pour les comptes de trésorerie, GET /v2/transactions/cash/{id} liste les transactions.
- Les points de terminaison de compte incluent GET /v2/accounts/card pour les comptes de carte et GET /v2/accounts/cash pour les comptes de trésorerie. Vous récupérez les relevés avec GET /v2/accounts/card/primary/statements.
- L'API Onboarding se concentre sur les parrainages. Vous créez des parrainages avec POST /v1/referrals, en fournissant referral_code et les détails du demandeur. Listez-les via GET /v1/referrals, et obtenez des détails spécifiques avec GET /v1/referrals/{id}. Les téléchargements de documents utilisent POST /v1/referrals/{id}/document_upload.
D'autres API incluent Payments pour les transferts (GET /v2/transfers), les Webhooks pour les notifications, et l'API Fields pour la gestion des champs personnalisés.
Tous les points de terminaison de liste prennent en charge la pagination avec cursor et limit, garantissant une récupération efficace des données.
Comment utiliser l'API Brex pour les transactions ?
Vous utilisez l'API Brex pour les transactions en appelant des points de terminaison de l'API Transactions. Tout d'abord, vous identifiez le type de compte—carte ou trésorerie.
Pour les transactions par carte, vous envoyez GET /v2/transactions/card/primary. Cela renvoie les achats réglés, les remboursements et les rétrofacturations. Vous filtrez par user_ids ou posted_at_start, comme "2025-01-01T00:00:00Z".
La réponse inclut des détails tels que le montant, la description, le commerçant et expense_id si développé.
Pour les transactions de trésorerie, vous spécifiez l'ID du compte dans GET /v2/transactions/cash/{id}. Cela liste toutes les activités pour ce compte de trésorerie.
Pour gérer les comptes, vous listez les comptes de carte avec GET /v2/accounts/card, qui renvoie les IDs et les statuts. De même, GET /v2/accounts/cash fournit les détails des comptes de trésorerie.
De plus, vous récupérez les relevés pour l'audit. Utilisez GET /v2/accounts/card/primary/statements pour obtenir les relevés de carte finalisés, paginés si nécessaire.
Dans le code, vous implémentez cela comme suit (exemple Python) :
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
params = {
'posted_at_start': '2025-12-01T00:00:00Z',
'limit': 50
}
response = requests.get('https://platform.brexapis.com/v2/transactions/card/primary', headers=headers, params=params)
transactions = response.json()['items']
for tx in transactions:
print(f"Amount: {tx['amount']['amount']}, Description: {tx['description']}")
Ce script récupère et affiche les transactions récentes, démontrant une utilisation pratique.
De plus, vous gérez les erreurs comme 404 pour les ID invalides en vérifiant response.status_code.
Comment gérer les équipes avec l'API Équipe Brex ?
Vous gérez les équipes en utilisant les points de terminaison de l'API Équipe. Commencez par lister les utilisateurs avec GET /v2/users. Cela vous aide à auditer les membres actuels de l'équipe.
Pour ajouter un utilisateur, POST /v2/users avec les champs requis :
{
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"department_id": "dept_123"
}
Le système envoie automatiquement un e-mail d'invitation.
Vous mettez à jour les détails de l'utilisateur, comme l'attribution d'un nouveau responsable, via PUT /v2/users/{id}.
Pour le contrôle des dépenses, POST /v2/users/{id}/limit définit les budgets mensuels.
Les départements et les emplacements améliorent l'organisation. Vous créez un département avec POST /v2/departments :
{
"name": "Engineering",
"description": "Software development team"
}
Ensuite, assignez-y des utilisateurs lors de l'invitation ou de la mise à jour.
Les cartes sont liées aux utilisateurs. Vous créez une carte virtuelle pour un utilisateur :
{
"owner": {
"user_id": "user_456"
},
"card_name": "Project Card",
"card_type": "VIRTUAL",
"limit_type": "CARD",
"spend_controls": {
"limit": {
"amount": 5000,
"currency": "USD"
}
}
}
Envoyez cela à /v2/cards.
Plus tard, vous verrouillez une carte si nécessaire : POST /v2/cards/{id}/lock avec la raison "OTHER".
Cette approche garantit une gestion d'équipe sécurisée.
Intégration de l'API Brex avec votre application : Exemples de code
Vous intégrez l'API Brex en incorporant des appels API dans votre code. Utilisez des bibliothèques comme requests en Python ou axios en JavaScript.
Pour un exemple Node.js, installez axios :
npm install axios
Ensuite, récupérez les utilisateurs :
const axios = require('axios');
const headers = {
Authorization: 'Bearer your_token_here'
};
axios.get('https://platform.brexapis.com/v2/users', { headers })
.then(response => {
console.log(response.data.items);
})
.catch(error => {
console.error(error.response.data);
});
Ceci enregistre les données utilisateur.
Pour des intégrations plus complexes, vous utilisez des webhooks. Abonnez-vous aux événements via l'API Webhooks, en configurant des points de terminaison pour recevoir des notifications sur les mises à jour de transactions.
En Python, gérez la pagination pour les grands ensembles de données :
def fetch_all_users(headers, cursor=None):
users = []
while True:
params = {'limit': 100, 'cursor': cursor}
response = requests.get('https://platform.brexapis.com/v2/users', headers=headers, params=params)
data = response.json()
users.extend(data['items'])
cursor = data['next_cursor']
if not cursor:
break
return users
Cette fonction récupère tous les utilisateurs de manière itérative.
Vous sécurisez également les données sensibles, comme les numéros de carte, en utilisant GET /v2/cards/{id}/pan uniquement lorsque cela est nécessaire et en ne stockant rien localement.
Comment tester l'API Brex avec Apidog ?
Vous testez l'API Brex efficacement en utilisant Apidog, une plateforme tout-en-un pour le développement d'API. Apidog vous permet de concevoir, déboguer, simuler, tester et documenter les API de manière intuitive.
Ensuite, configurez l'authentification en ajoutant votre jeton d'authentification (bearer token) dans les variables globales ou les paramètres d'environnement. Cela s'applique à toutes les requêtes.
Vous envoyez ensuite des requêtes, telles que GET /v2/users/me, et visualisez les réponses dans une interface conviviale. Apidog met en évidence les structures JSON et les erreurs.
De plus, vous créez des scénarios de test avec des assertions. Par exemple, affirmez qu'une réponse de transaction a un statut 200 et contient 'amount'.
La fonction de simulation d'Apidog simule des réponses pour les points de terminaison non disponibles, facilitant le développement.
De plus, générez de la documentation avec des exemples de code dans plusieurs langues, en la partageant avec votre équipe.
En utilisant Apidog, vous rationalisez les tests de l'API Brex, en détectant les problèmes précocement.
Quelles sont les meilleures pratiques pour utiliser l'API Brex ?
Vous suivez les meilleures pratiques pour optimiser l'utilisation de l'API Brex. Utilisez toujours HTTPS et stockez les jetons en toute sécurité, peut-être dans des variables d'environnement ou des coffres-forts.
Implémentez la gestion des limites de débit, car Brex applique des limites—réessayez avec un délai d'attente exponentiel en cas d'erreurs 429.
- Paginer les requêtes pour éviter les délais d'expiration ; utilisez cursor et limit de manière cohérente.
- Surveillez l'expiration des jetons et automatisez leur renouvellement.
- Validez les entrées avant de les envoyer pour prévenir les erreurs 400.
- Enregistrez les appels API pour le débogage, mais anonymisez les données sensibles.
- Utilisez des clés d'idempotence pour POST/PUT afin d'éviter les doublons.
- Intégrez la gestion des erreurs : Mappez les codes HTTP à des actions, comme le rafraîchissement des jetons en cas de 401.
- Testez dans des environnements de staging avant la production.
- Restez informé des changements via le changelog de Brex.
Ces pratiques garantissent des intégrations fiables.
Problèmes courants et comment dépanner les problèmes de l'API Brex ?
Vous rencontrez des problèmes tels que des échecs d'authentification. Si vous obtenez une erreur 401, vérifiez la validité du jeton—régénérez-le s'il a expiré.
- Pour une erreur 403 Forbidden, vérifiez que les scopes correspondent au point de terminaison.
- L'erreur 404 Not Found signifie souvent des ID invalides ; vérifiez les chemins.
- Les dépassements de limite de débit entraînent une erreur 429 ; implémentez un délai d'attente.
- Les erreurs réseau nécessitent une logique de réessai.
Utilisez les collections Postman de Brex pour les tests initiaux, en les forquant depuis leur espace de travail.
Si les problèmes persistent, consultez la documentation ou contactez le support.
Conclusion
Vous comprenez maintenant comment accéder et utiliser l'API Brex de manière exhaustive. De l'authentification à l'utilisation des points de terminaison et aux tests avec Apidog, ces étapes permettent des intégrations robustes. Appliquez-les pour améliorer efficacement vos flux de travail financiers.
