Documentación / API

Tu primera consulta,
paso a paso.

Envía una placa y una fuente. Recupera el resultado cuando la consulta termine. Tu token permanece en el servidor de tu aplicación.

01. Acceso y autenticación

La API utiliza autenticación Bearer. Solicita acceso para definir las fuentes habilitadas, las cuotas y el token de tu empresa.

URL base: https://api.placa.pe. Envía las solicitudes desde tu backend. No incluyas tokens privados en JavaScript del navegador, aplicaciones públicas o repositorios.

Cabecera HTTP
Authorization: Bearer TU_TOKEN

02. Crear una consulta

Usa POST /v1/consultas con una fuente y una placa. Cada solicitud consulta una fuente. Para consultar varias, crea una solicitud por fuente.

cURL
curl -X POST https://api.placa.pe/v1/consultas \
  -H "Authorization: Bearer TU_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: consulta-abc123-infogas-001" \
  -d '{"source":"infogas","plate":"ABC123"}'

La cabecera Idempotency-Key identifica tu solicitud (entre 8 y 128 caracteres ASCII). Conserva la misma clave al reintentar la misma consulta; utiliza una nueva para una consulta distinta.

Una consulta nueva devuelve 202 Accepted y un job_id. La API procesa el trabajo de forma asíncrona; esa aceptación todavía no es el resultado de la fuente.

03. Recuperar el resultado

Consulta el trabajo con el mismo token. Sustituye JOB_ID por el identificador recibido al crear la consulta.

cURL
curl https://api.placa.pe/v1/consultas/JOB_ID \
  -H "Authorization: Bearer TU_TOKEN"

El resultado está en result cuando state es completed. Mientras el trabajo siga pendiente, espera antes de volver a consultar su estado; evita ciclos de solicitudes sin pausa.

Un resultado vacío, una fuente no disponible y una consulta expirada son situaciones diferentes. Mantén esa distinción en tu interfaz.

04. Estados y errores

  • 200 / 202: solicitud atendida o aceptada para procesamiento. Revisa el estado del trabajo.
  • 401 / 403: revisa la autenticación y los permisos de tu token.
  • 409: la clave de idempotencia ya corresponde a otra consulta.
  • 429: se alcanzó un límite de uso. Ajusta el ritmo de solicitudes según tu acceso.
  • 503: el envío no pudo completarse. Si reintentas la misma consulta, conserva su clave de idempotencia.

Las fuentes habilitadas y los límites se acuerdan para cada integración. Cuéntanos qué necesita tu equipo para revisar el flujo contigo.