Autenticación y scopes
Tokens de integración
El acceso a la API se hace con un token de integración: un JWT permanente (no expira) emitido por el equipo de Ripei, asociado a tu empresa y limitado a un conjunto de scopes (permisos).
Para obtener uno, contacta a tu representante de Ripei o escribe a
soporte@pagosripei.com indicando:
- El nombre del sistema que va a usar el token (ej. “ERP Contabilidad”).
- Los scopes que necesita (ver catálogo abajo). Pide solo los que vas a usar — es tu primera línea de seguridad.
El token se entrega una sola vez. Guárdalo en un lugar seguro (variables de entorno, secret manager); Ripei no puede volver a mostrártelo, solo generar uno nuevo.
Revocación. Si un token se filtra o dejas de usarlo, solicita su revocación al equipo de Ripei — es inmediata e irreversible. Buena práctica: pide un token distinto por sistema, así puedes revocar uno sin afectar los demás.
Headers obligatorios
Toda petición lleva:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
company: 42
Content-Type: application/json| Header | Descripción |
|---|---|
Authorization | Bearer + tu token de integración. |
company | El ID numérico de tu empresa en Ripei (te lo entrega el equipo junto con el token). Debe coincidir con la empresa del token — un token no puede operar sobre otra empresa. |
Catálogo de scopes
| Scope | Permite |
|---|---|
group.create | Crear grupos familiares |
company-user.create | Crear clientes |
company-user.view | Consultar clientes |
plan.create | Crear planes |
plan.update | Editar planes |
planSettings.create | Crear configuraciones de cuotas |
subscription.create | Crear suscripciones |
bill.create | Crear facturas |
bill.update | Confirmar/actualizar facturas |
bill.view | Consultar facturas y estadísticas |
user-bank.create | Registrar cuentas bancarias de clientes |
user-bank.view | Consultar cuentas bancarias de clientes |
user-bank.update | Editar cuentas bancarias de clientes |
user-bank.delete | Eliminar cuentas bancarias de clientes |
Cada endpoint de esta documentación indica el scope que requiere. Si tu token no lo tiene, la
API responde 401.
Ejemplo
curl -X POST https://api.qa.pagosripei.com/group/company \
-H "Authorization: Bearer $RIPEI_TOKEN" \
-H "company: 42" \
-H "Content-Type: application/json" \
-d '{ "name": "Familia Pérez" }'Prueba siempre primero en QA (api.qa.pagosripei.com) con el token de QA. Los tokens de
QA y producción son independientes.