Los desarrolladores a menudo buscan formas eficientes de integrar servicios financieros en sus aplicaciones, y la API de Brex se destaca como una solución robusta para administrar límites de gasto, transacciones y recursos de equipo. Este artículo lo guiará a través del proceso de acceso y uso de la API de Brex. Aprenderá cómo configurar la autenticación, explorar los endpoints e incorporar la API en sus sistemas.
A medida que avanza, recuerde que pequeños ajustes en su enfoque, como elegir los scopes correctos durante la generación de tokens, pueden impactar significativamente el éxito de la integración. Por lo tanto, preste mucha atención a cada paso para asegurar una conectividad fluida.
¿Qué es la API de Brex?
La API de Brex proporciona una interfaz RESTful que permite a los desarrolladores automatizar y personalizar flujos de trabajo financieros dentro de la plataforma Brex. Brex, una empresa de tecnología financiera, ofrece servicios como tarjetas corporativas, gestión de gastos y seguimiento de gastos. En consecuencia, la API de Brex le permite interactuar con estas funciones programáticamente.
La API de Brex incluye varias APIs especializadas, como la API de Equipo para gestionar usuarios y tarjetas, la API de Transacciones para obtener transacciones liquidadas y la API de Onboarding para gestionar referencias. Cada una de ellas atiende diferentes aspectos de la gestión financiera, lo que le permite crear informes personalizados, automatizar invitaciones de usuarios o rastrear gastos en tiempo real.
Además, Brex enfatiza la seguridad y el cumplimiento, asegurando que las interacciones de la API se alineen con los estándares de la industria. Por lo tanto, cuando utiliza la API de Brex, obtiene acceso a herramientas que respaldan operaciones financieras escalables sin comprometer la integridad de los datos.
¿Por qué debería usar la API de Brex?
Debe usar la API de Brex si su aplicación requiere integración con herramientas financieras corporativas. Por ejemplo, los equipos financieros a menudo necesitan sincronizar datos de transacciones con software de contabilidad, y la API de Brex facilita esto al proporcionar endpoints para listar transacciones y cuentas.
Además, la API reduce los esfuerzos manuales en la gestión de límites de gasto y acceso de usuarios. Puede automatizar la creación de tarjetas, establecer límites mensuales y monitorear actividades, lo que agiliza las operaciones para empresas en crecimiento. Además, los socios de contabilidad o recursos humanos pueden aprovechar la API de Onboarding para crear enlaces de referencia personalizados, mejorando los procesos de adquisición de clientes.
Sin embargo, el verdadero valor reside en su flexibilidad. Puede integrar la API de Brex con sistemas existentes para crear paneles o alertas personalizados, asegurando que los datos financieros fluyan eficientemente entre plataformas. Como resultado, los desarrolladores ahorran tiempo y reducen errores en comparación con la entrada manual de datos.
¿Cómo empezar a usar la API de Brex?
Para empezar a usar la API de Brex, primero debe registrarse para obtener una cuenta de Brex si no tiene una. Visite brex.com y cree una cuenta como administrador, ya que solo los administradores de cuenta o los administradores de tarjetas pueden generar tokens de API.
Luego, inicie sesión en el panel de Brex.
Navegue a la sección de Desarrollador en Configuración. Aquí, haga clic en Crear Token para iniciar el proceso. Proporcione un nombre para el token, lo que ayuda a identificar su propósito más tarde, como "Token de integración para la aplicación".
Además, seleccione los scopes apropiados durante este paso. Los scopes definen los niveles de acceso a los datos, como acceso de lectura a transacciones o permisos de escritura para la gestión de usuarios. Después de confirmar sus selecciones, haga clic en Permitir acceso y el sistema generará el token.
Es importante que copie y almacene este token de forma segura de inmediato, ya que Brex lo ofusca después de la creación por razones de seguridad. Si lo pierde, simplemente cree uno nuevo. Los tokens caducan después de 90 días de inactividad, por lo que debe monitorear el uso para evitar interrupciones.
Una vez que tenga el token, pruebe la conectividad básica. Por ejemplo, utilice una herramienta como curl para realizar una solicitud GET simple a un endpoint, incluyendo el token en el encabezado de Autorización. Esto verifica que su configuración funciona correctamente.
¿Cómo autenticarse con la API de Brex?
Usted se autentica con la API de Brex utilizando tokens de portador (bearer tokens). Específicamente, debe incluir el token en el encabezado de Autorización de cada solicitud, con el formato "Bearer {su_token}".
Por ejemplo, considere este ejemplo de curl:
curl -X GET https://platform.brexapis.com/v2/users/me \
-H "Authorization: Bearer bxt_jBWQLZXtu1f4sVT6UjaWPp7Gh9nVGjzEZgRX"
Esta solicitud obtiene los detalles del usuario actual. Si tiene éxito, devuelve datos JSON sobre el usuario.
Además, Brex admite tokens de usuario, que están vinculados a privilegios administrativos específicos. Usted genera estos tokens como se describió anteriormente, asegurándose de elegir los scopes que se ajusten a sus necesidades. Por ejemplo, si planea administrar tarjetas, seleccione scopes para leer y escribir en los endpoints de tarjetas.
Sin embargo, si un token se ve comprometido, debe revocarlo inmediatamente desde la página de Desarrollador en el panel de control. Los tokens revocados harán que las llamadas posteriores a la API fallen con un error 401, protegiendo su cuenta.
En la práctica, usted implementa la gestión de tokens en el código de su aplicación. Las bibliotecas como el módulo `requests` de Python simplifican esto:
import requests
headers = {
'Authorization': 'Bearer your_token_here'
}
response = requests.get('https://platform.brexapis.com/v2/users/me', headers=headers)
print(response.json())
Este fragmento de código demuestra la autenticación activa en un script.
¿Cuáles son los endpoints clave de la API de Brex?
La API de Brex ofrece varios endpoints en múltiples APIs. Puede comenzar explorando la API de Equipo, que gestiona usuarios, departamentos, ubicaciones, tarjetas y más.
- Para usuarios, puede listar todos los usuarios con GET /v2/users, filtrando por correo electrónico o ID. Los parámetros incluyen cursor para paginación y limit para controlar el tamaño de la respuesta. De manera similar, puede invitar a un nuevo usuario a través de POST /v2/users, proporcionando first_name, last_name, email y opcionalmente manager_id.
Además, puede actualizar usuarios con PUT /v2/users/{id}, cambiando el estado a ACTIVE o DISABLED. También puede establecer límites mensuales usando POST /v2/users/{id}/limit, especificando la cantidad en el cuerpo.
- Para departamentos, puede crear uno con POST /v2/departments, que requiere un nombre. Puede listarlos a través de GET /v2/departments y recuperar detalles específicos con GET /v2/departments/{id}.
- Las ubicaciones siguen un patrón similar: POST /v2/locations para la creación, GET /v2/locations para el listado.
- Los títulos, que representan roles laborales, utilizan endpoints como POST /v2/titles y GET /v2/titles/{id}.
- Las tarjetas forman una parte central. Puede listar tarjetas con GET /v2/cards, filtradas por user_id. Para crear una tarjeta, use POST /v2/cards con detalles como owner, card_type (VIRTUAL o PHYSICAL) y spend_controls. Spend_controls incluyen limit_type y amounts.
Además, puede actualizar tarjetas a través de PUT /v2/cards/{id}, bloquearlas con POST /v2/cards/{id}/lock (proporcionando una razón como FRAUD) o terminarlas con POST /v2/cards/{id}/terminate.
- Las operaciones sensibles incluyen GET /v2/cards/{id}/pan para números de tarjeta y POST /v2/cards/{id}/secure_email para enviar detalles de forma segura.
- Las entidades legales y empresas tienen endpoints de solo lectura como GET /v2/legal_entities y GET /v2/company.
- Pasando a la API de Transacciones, puede obtener transacciones de tarjetas liquidadas con GET /v2/transactions/card/primary, utilizando parámetros como posted_at_start para filtrar por fecha. Para cuentas de efectivo, GET /v2/transactions/cash/{id} lista las transacciones.
- Los endpoints de cuenta incluyen GET /v2/accounts/card para cuentas de tarjeta y GET /v2/accounts/cash para cuentas de efectivo. Puede recuperar extractos con GET /v2/accounts/card/primary/statements.
- La API de Onboarding se centra en las referencias. Puede crear referencias con POST /v1/referrals, proporcionando referral_code y los detalles del solicitante. Listarlas a través de GET /v1/referrals y obtener detalles específicos con GET /v1/referrals/{id}. Las cargas de documentos utilizan POST /v1/referrals/{id}/document_upload.
Otras APIs incluyen Pagos para transferencias (GET /v2/transfers), Webhooks para notificaciones y la API de Campos para gestionar campos personalizados.
Todos los endpoints de lista admiten paginación con cursor y límite, asegurando una recuperación eficiente de datos.
¿Cómo usar la API de Brex para transacciones?
Usted utiliza la API de Brex para transacciones llamando a los endpoints de la API de Transacciones. Primero, identifica el tipo de cuenta: tarjeta o efectivo.
Para transacciones con tarjeta, envía GET /v2/transactions/card/primary. Esto devuelve compras liquidadas, reembolsos y contracargos. Puede filtrar por user_ids o posted_at_start, como "2025-01-01T00:00:00Z".
La respuesta incluye detalles como el monto, la descripción, el comerciante y el expense_id si se expande.
Para transacciones en efectivo, especifica el ID de la cuenta en GET /v2/transactions/cash/{id}. Esto enumera todas las actividades para esa cuenta de efectivo.
Para administrar cuentas, enumera las cuentas de tarjeta con GET /v2/accounts/card, que devuelve IDs y estados. De manera similar, GET /v2/accounts/cash proporciona detalles de las cuentas en efectivo.
Además, puede obtener extractos para auditorías. Use GET /v2/accounts/card/primary/statements para obtener extractos de tarjeta finalizados, paginados según sea necesario.
En el código, implementa esto de la siguiente manera (ejemplo en 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']}")
Este script obtiene e imprime transacciones recientes, demostrando un uso práctico.
Además, maneja errores como 404 para IDs inválidos verificando response.status_code.
¿Cómo gestionar equipos con la API de equipo de Brex?
Usted gestiona equipos utilizando los endpoints de la API de Equipo. Comience listando usuarios con GET /v2/users. Esto le ayuda a auditar a los miembros actuales del equipo.
Para añadir un usuario, POST /v2/users con los campos requeridos:
{
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"department_id": "dept_123"
}
El sistema envía un correo electrónico de invitación automáticamente.
Usted actualiza los detalles del usuario, como asignar un nuevo gerente, a través de PUT /v2/users/{id}.
Para el control de gastos, POST /v2/users/{id}/limit establece presupuestos mensuales.
Los departamentos y ubicaciones mejoran la organización. Usted crea un departamento con POST /v2/departments:
{
"name": "Engineering",
"description": "Software development team"
}
Luego, asigne usuarios a él durante la invitación o actualización.
Las tarjetas se vinculan a los usuarios. Usted crea una tarjeta virtual para un usuario:
{
"owner": {
"user_id": "user_456"
},
"card_name": "Project Card",
"card_type": "VIRTUAL",
"limit_type": "CARD",
"spend_controls": {
"limit": {
"amount": 5000,
"currency": "USD"
}
}
}
POST esto a /v2/cards.
Más tarde, puede bloquear una tarjeta si es necesario: POST /v2/cards/{id}/lock con la razón "OTHER".
Este enfoque asegura una gestión segura del equipo.
Integrando la API de Brex con el código de su aplicación: ejemplos de código
Usted integra la API de Brex incorporando llamadas a la API en su base de código. Utilice bibliotecas como `requests` en Python o axios en JavaScript.
Para un ejemplo en Node.js, instale axios:
npm install axios
Luego, obtenga usuarios:
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);
});
Esto registra los datos del usuario.
Para integraciones más complejas, utilice webhooks. Suscríbase a eventos a través de la API de Webhooks, configurando endpoints para recibir notificaciones sobre actualizaciones de transacciones.
En Python, maneje la paginación para grandes conjuntos de datos:
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
Esta función recupera todos los usuarios de forma iterativa.
También debe proteger los datos sensibles, como los números de tarjeta, utilizando GET /v2/cards/{id}/pan solo cuando sea necesario y no almacenando nada localmente.
¿Cómo puede probar la API de Brex con Apidog?
Usted prueba la API de Brex de manera efectiva utilizando Apidog, una plataforma todo en uno para el desarrollo de API. Apidog le permite diseñar, depurar, simular, probar y documentar APIs de forma intuitiva.
A continuación, configure la autenticación añadiendo su token de portador (bearer token) en las variables globales o la configuración del entorno. Esto se aplica a todas las solicitudes.
Luego, envía solicitudes, como GET /v2/users/me, y ve las respuestas en una interfaz fácil de usar. Apidog resalta las estructuras JSON y los errores.
Además, puede crear escenarios de prueba con aserciones. Por ejemplo, afirme que una respuesta de transacción tiene un estado 200 y contiene 'amount'.
La función de simulación de Apidog simula respuestas para endpoints no disponibles, lo que ayuda al desarrollo.
Además, genere documentación con ejemplos de código en varios idiomas y compártala con su equipo.
Al usar Apidog, optimiza las pruebas de la API de Brex, detectando problemas a tiempo.
¿Cuáles son las mejores prácticas para usar la API de Brex?
Usted sigue las mejores prácticas para optimizar el uso de la API de Brex. Siempre use HTTPS y almacene los tokens de forma segura, quizás en variables de entorno o bóvedas.
Implemente el manejo de límites de tasa, ya que Brex aplica límites; reintente con retroceso exponencial en errores 429.
- Pagine las solicitudes para evitar tiempos de espera; use el cursor y el límite de manera consistente.
- Monitoree la expiración del token y automatice la renovación.
- Valide las entradas antes de enviarlas para evitar errores 400.
- Registre las llamadas a la API para depuración, pero anonimice los datos sensibles.
- Use claves de idempotencia para POST/PUT para evitar duplicados.
- Integre el manejo de errores: mapee los códigos HTTP a acciones, como actualizar tokens en 401.
- Pruebe en entornos de prueba antes de la producción.
- Manténgase actualizado con el registro de cambios de Brex para novedades.
Estas prácticas aseguran integraciones confiables.
Problemas comunes y cómo solucionar problemas de la API de Brex
Usted puede encontrar problemas como fallos de autenticación. Si obtiene un 401, verifique la validez del token; regenérelo si ha caducado.
- Para un 403 Prohibido, verifique que los alcances (scopes) coincidan con el endpoint.
- Un 404 No encontrado a menudo significa IDs inválidos; revise las rutas.
- Si se excede el límite de tasa, obtiene un 429; implemente una estrategia de retroceso.
- Los errores de red requieren lógica de reintento.
Utilice las colecciones de Postman de Brex para las pruebas iniciales, bifurcando desde su espacio de trabajo.
Si los problemas persisten, consulte la documentación o contacte con el soporte.
Conclusión
Ahora comprende cómo acceder y usar la API de Brex de manera integral. Desde la autenticación hasta el uso de endpoints y las pruebas con Apidog, estos pasos permiten integraciones robustas. Aplíquelos para mejorar sus flujos de trabajo financieros de manera eficiente.
