descripción general de la API de D1

Formatos de datos, transporte, reglas de compatibilidad y política de obsolescencia para la API de D1.

Diseño de la API

Formato de datos

Las solicitudes y respuestas usan JSON. La codificación de cadenas es UTF-8 salvo indicación contraria.

Protocolo de transporte

Todas las interfaces usan HTTPS. Se requieren TLS mutuo (mTLS) y OAuth 2.0.

Reglas de compatibilidad retroactiva

Estas reglas le ayudan a construir integraciones que sigan funcionando a medida que evoluciona la API D1.

• Aceptar campos desconocidos. Thales puede añadir Opcional parámetros en encabezados, URL y cuerpos. Su integración no debe romperse cuando aparezcan nuevos campos.

La “validación estricta” rechaza solicitudes o respuestas que contienen campos que no están en su versión actual de la especificación.

• Trate las cadenas de mensajes de error como información. No dependa de un formato fijo.
• Espere cambios en los requisitos con el tiempo:

  • Los parámetros en las respuestas D1 pueden cambiar de Opcional a Obligatorio.
  • Los parámetros en las solicitudes del emisor pueden cambiar de Obligatorio a Opcional.
• Ignorar el orden de los campos JSON.
• Aceptar nuevos valores enum.
• Esperar nuevas operaciones de API (recursos y métodos HTTP).
• Esperar nuevos códigos de estado HTTP en las respuestas.

Fin de vida de parámetros/operaciones de la API

Thales proporciona un aviso con al menos 9 meses antes del fin de vida de cualquier parámetro u operación de API en desuso.

Después de que finalice el periodo de desaprobación, debe dejar de usar los parámetros y operaciones en desuso en todos los entornos, incluida Producción.

Thales puede acortar el periodo de desaprobación, sin limitación a las siguientes condiciones:

• Un riesgo de seguridad significativo
• Un impacto económico o técnico material sustancial
• Requisitos de la ley aplicable o de las redes de pago

Los parámetros y operaciones de API en desuso están marcados como en desuso en la documentación.