Referencia de la API

Liveness (sin autenticación)

curl https://api.credikul.com/v1/health \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Introspección de la llave (tenant, scopes, entorno)

curl https://api.credikul.com/v1/me \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Catálogo de ciudades didi (para el alta de vehículos)

curl https://api.credikul.com/v1/catalog/didi/cities \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Catálogo de colores didi

curl https://api.credikul.com/v1/catalog/didi/colors \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Listar vehículos

Scope: `vehicles:read`. Paginación por cursor (`startingAfter`).

curl https://api.credikul.com/v1/vehicles \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Crear vehículo

Scope: `vehicles:write`. La placa y el VIN son únicos en TODA la flota Credikul (409 si ya existen).

curl -X POST https://api.credikul.com/v1/vehicles \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"plate":"<string>","brand":"<string>","model":"<string>","year":"<integer>","color":"<string>"}'

Obtener vehículo

curl https://api.credikul.com/v1/vehicles/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Actualizar vehículo (city/color/vin/status/notes)

curl -X PATCH https://api.credikul.com/v1/vehicles/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{}'

Registrar el vehículo en una plataforma (alta)

Scope: `vehicles:write`. didi: registro asíncrono (queda `pending` y requiere la tarjeta de circulación). indrive: instantáneo (requiere VIN). Idempotente: si ya está registrado responde 200 con el mismo objeto.

curl -X POST https://api.credikul.com/v1/vehicles/{id}/registrations \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"platform":"<\"didi\" | \"indrive\">"}'

Estado de registro en todas las plataformas

curl https://api.credikul.com/v1/vehicles/{id}/registrations \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Estado de registro en una plataforma (objetivo de polling)

curl https://api.credikul.com/v1/vehicles/{id}/registrations/{platform} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Refrescar el veredicto de revisión en vivo (solo didi)

curl -X POST https://api.credikul.com/v1/vehicles/{id}/registrations/{platform}/refresh \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Subir la tarjeta de circulación (frente)

Scope: `documents:write`. Multipart: campo `file` (JPEG/PNG, máx 4 MB) + `type=circulation_card_front`. Requiere registro didi previo (409 si falta).

curl -X POST https://api.credikul.com/v1/vehicles/{id}/documents \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -F "type=circulation_card_front" \
  -F "file=@tarjeta-frente.jpg"

Historial de documentos del vehículo

curl https://api.credikul.com/v1/vehicles/{id}/documents \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Listar conductores

curl https://api.credikul.com/v1/drivers \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Crear conductor

Scope: `drivers:write`. El WhatsApp es único en toda la flota Credikul (409). `vehicleId` opcional abre la asignación.

curl -X POST https://api.credikul.com/v1/drivers \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"name":"<string>","whatsapp":"<string>","city":"<string>"}'

Obtener conductor

curl https://api.credikul.com/v1/drivers/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Actualizar conductor

El WhatsApp se congela cuando el conductor ya aceptó la invitación (409).

curl -X PATCH https://api.credikul.com/v1/drivers/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{}'

Invitar al conductor a una plataforma

Scope: `drivers:write`. didi: envía la invitación que el conductor acepta en su app (consulta el estado con GET/refresh). indrive: no disponible en v1 (403 PLATFORM_NOT_ENABLED). Idempotente: si ya hay invitación responde 200.

curl -X POST https://api.credikul.com/v1/drivers/{id}/invitations \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"platform":"<\"didi\" | \"indrive\">"}'

Estado de invitaciones del conductor

curl https://api.credikul.com/v1/drivers/{id}/invitations \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

¿Ya aceptó? — estado almacenado de la invitación

curl https://api.credikul.com/v1/drivers/{id}/invitations/{platform} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Consultar la plataforma en vivo y persistir el estado

curl -X POST https://api.credikul.com/v1/drivers/{id}/invitations/didi/refresh \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Cancelar la invitación / desvincular al conductor

curl -X DELETE https://api.credikul.com/v1/drivers/{id}/invitations/didi \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Listar asignaciones conductor↔vehículo

curl https://api.credikul.com/v1/assignments \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Asignar un conductor a un vehículo

Scope: `drivers:write`. Un vehículo y un conductor solo pueden tener UNA asignación activa: crear una nueva desplaza (termina) la anterior en cualquiera de los dos lados. La asignación local gobierna la vinculación en la plataforma.

curl -X POST https://api.credikul.com/v1/assignments \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"vehicleId":"<uuid>","driverId":"<uuid>"}'

Obtener asignación

curl https://api.credikul.com/v1/assignments/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Terminar la asignación

curl -X DELETE https://api.credikul.com/v1/assignments/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Invitar varios conductores (didi) — async

Scope: `drivers:write`. Responde 202 con `jobId`; consulta el avance en GET /v1/jobs/{id}. `skipped` = conductores no elegibles (ya invitados, inexistentes).

curl -X POST https://api.credikul.com/v1/drivers/invitations/batch \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"platform":"<\"didi\" | \"indrive\">","driverIds":"<array<uuid>>"}'

Registrar varios vehículos en una plataforma — async

Scope: `vehicles:write`. Responde 202 con `jobId`; consulta el avance en GET /v1/jobs/{id}.

curl -X POST https://api.credikul.com/v1/vehicles/registrations/batch \
  -H "Authorization: Bearer ck_live_TU_LLAVE" \
  -H "Content-Type: application/json" \
  -d '{"platform":"<\"didi\" | \"indrive\">","vehicleIds":"<array<uuid>>"}'

Avance de un job por lotes

curl https://api.credikul.com/v1/jobs/{id} \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Listar viajes (por plataforma)

Scope: `rides:read`. `platform` es requerido. Dinero como string decimal MXN; fechas en día calendario CDMX (−06:00 fijo). Las métricas de indrive se asientan hasta 16 días — re-consulta ventanas recientes.

curl https://api.credikul.com/v1/rides \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Ganancias diarias por conductor

curl https://api.credikul.com/v1/earnings/daily \
  -H "Authorization: Bearer ck_live_TU_LLAVE"

Totales del periodo

curl https://api.credikul.com/v1/earnings/summary \
  -H "Authorization: Bearer ck_live_TU_LLAVE"