Introducción
La API de Credikul te permite operar tu flotilla desde tus propios sistemas: dar de alta vehículos en las plataformas donde trabajas, invitar conductores, subir documentos y consultar viajes y ganancias — sin tocar un panel.
URL base
https://api.credikul.com/v1
Todas las respuestas son JSON UTF-8. Los campos usan camelCase en inglés (plate, driverId); los mensajes de error llegan en español.
El modelo
Tu flotilla es un tenant dentro de Credikul. Cada llave API pertenece a tu flotilla y solo ve tus datos: tus vehículos, tus conductores, tus viajes. El aislamiento se aplica a nivel de base de datos en cada consulta.
Los recursos principales:
| Recurso | Qué es |
|---|---|
vehicles |
Tus unidades. Se crean localmente y luego se registran en cada plataforma. |
drivers |
Tus conductores. Se crean localmente y luego se invitan a la plataforma. |
assignments |
Qué conductor maneja qué vehículo. La asignación local gobierna la vinculación en la plataforma. |
rides / earnings |
Viajes y ganancias ingeridos desde las plataformas. |
Plataformas
En v1 la API opera con didi e indrive (siempre en minúsculas en los payloads). Cada una funciona distinto y la API te lo dice en cada respuesta:
- didi — el alta de vehículos es asíncrona: registras, subes la tarjeta de circulación y DiDi revisa. La invitación de conductores requiere que el conductor acepte en su app.
- indrive — el alta de vehículos es instantánea (placa + VIN). La asignación de conductores no está disponible en v1 (responde
403 PLATFORM_NOT_ENABLED).
Versionado
La API vive bajo /v1. Los cambios son aditivos: campos y endpoints nuevos pueden aparecer, pero nada se renombra ni se elimina dentro de v1. Programa tus clientes para tolerar campos desconocidos.
Operaciones por lote
Para flotas grandes hay endpoints por lote (POST /v1/vehicles/registrations/batch, POST /v1/drivers/invitations/batch): responden 202 con un jobId que consultas en GET /v1/jobs/{id} — total, procesados y el resultado por unidad.
Próximamente
- Webhooks — te avisaremos cuando un conductor acepte una invitación o cuando DiDi apruebe un vehículo, sin necesidad de polling.
Siguiente paso
Crea tu llave en el portal (Desarrolladores → Crear llave API) y sigue la guía de Autenticación.