Artículo 6 de 8

Qué devuelve la API

JSON, siempre el recurso completo, y un código de error estable cuando algo falla.

Las respuestas

  • Crear un reloj devuelve el reloj, con su watchId. Es ese watchId (y no id) el que se indica después para vincular la tarjeta.
  • Comprobar una tarjeta (can-link-card) devuelve canLinkCard y un passportCheck: el nivel aplicado, los campos que faltan, los números de serie ya registrados.
  • Vincular la tarjeta devuelve el pasaporte creado, con su número de tarjeta (certificateCardId).
  • Leer un pasaporte devuelve toda su información: el reloj, sus fotos, su nivel de autenticación, su estado de robo, su garantía, su propietario tal como usted tiene derecho a verlo.

Las listas están paginadas. Las etiquetas siguen el idioma pedido en el encabezado accept-language (inglés por defecto).

Encontrar un pasaporte por su referencia

GET /certificates/by-external-ref/{ref} devuelve el pasaporte creado para su referencia, la misma respuesta que GET /certificates/{certificateCardId}. Solo ve lo que usted ha creado. La búsqueda ignora mayúsculas y espacios, y una referencia que contiene / se codifica como %2F.

Mientras la tarjeta no esté vinculada, la respuesta es 404: GET /watches/by-external-ref/{ref} encuentra el reloj en todas las etapas.

Los errores

Un error devuelve un código HTTP y, en el cuerpo, un código estable (code), un mensaje en el idioma de la solicitud (message) y a veces detalles (params). Lea el código, no el mensaje, que puede cambiar. Por ejemplo:

Código HTTPcodeQué significa
422PASSPORT_INCOMPLETEFaltan campos: params.missingFields los enumera
409PASSPORT_SERIAL_ALREADY_REGISTEREDOtro pasaporte del fabricante tiene este número de serie
403PASSPORT_AUTHENTICATION_TYPE_NOT_ALLOWEDEste nivel de autenticación no está abierto a su actividad
400OWNERSHIP_PROFESSIONAL_OWNER_REFUSEDLa dirección declarada como propietario es la de un profesional
Artículo siguienteEl cambio de propietario y el servicio posventa