Saltar al contenido
Índice

Referencia de la API

Una API REST que habla JSON: cada respuesta lleva su código HTTP, y cada error, un code que se puede comparar y un mensaje en español.

URL base

Todas las rutas cuelgan de aquí. Solo por HTTPS.

URL base
https://plataforma.ndx-one.com/api/v1

Autenticación

Cada petición lleva el secreto de una llave de integración en la cabecera Authorization. La llave es de una empresa: todo lo que lee y escribe es de esa empresa y de lo compartido. Cómo se crea la llave.

Cabecera
Authorization: Bearer $NDX_LLAVE

Repetir sin duplicar

Todo POST lleva Idempotency-Key, de 1 a 200 caracteres. La misma clave con la misma petición devuelve la misma respuesta durante 24 horas sin volver a hacerla: si no sabes si una petición llegó, repítela con su clave. Cuándo repetir.

Errores

Todos con la misma forma, y con X-Request-Id en la respuesta: dánoslo si necesitas soporte.

Un error
{ "error": { "code": "invalid", "message": "El campo no es válido.", "field": "firstName" } }
  • 400Algo no es válido: error.field dice qué.
  • 401Sin llave, o no vale.
  • 403Fuera del plan (code plan) o sin permiso (code forbidden).
  • 404No existe o no lo alcanza.
  • 409duplicate, conflict, idempotency_conflict o in_progress.
  • 413El cuerpo es demasiado grande.
  • 422Nadie que pueda verlo puede recibirla (no_assignee).
  • 429Más de 120 peticiones por minuto. Con Retry-After.
  • 503No se pudo atender. Con Retry-After: repítela.

Operaciones