Versionado
La API para comercios y sus documentos son la versión 1 y, dentro de v1, solo crecen. Una integración escrita contra v1 sigue funcionando.
Las rutas, los nombres de campo, los códigos de error, los nombres de cabecera y los ejemplos de código se quedan en inglés: son el contrato.
Qué puede cambiar dentro de v1
- Un campo opcional nuevo en una respuesta, una solicitud o el documento de pedido.
- Una ruta nueva, un código de error nuevo, un evento de webhook nuevo o un valor nuevo en una lista de valores permitidos.
- Un esquema de firma nuevo junto a
v1=enCutOptim-Signature; los receptores ignoran los esquemas que no conocen.
Qué no cambia nunca dentro de v1
- Ningún campo desaparece, se renombra o cambia de significado.
- Ninguna ruta cambia su ruta, su clave ni la forma de su respuesta.
- Un código de error conserva su significado.
Escribe un lector tolerante
Ignora los campos que no conozcas, trata un código de error desconocido según su estado HTTP y acepta con un 2xx un tipo de evento de webhook al que no te hayas suscrito. El schemaVersion del documento de pedido y de todos los cuerpos de webhook es 1.
Un cambio incompatible
Un cambio incompatible sería un documento nuevo (order.v2) o una ruta nueva (/cfg/v2) junto a v1, nunca una reescritura de v1. Se anunciaría en el Registro de cambios.
Aquí no hay un botón «probar» a propósito: la clave secreta pertenece a tu servidor, nunca a un navegador. La tienda demo muestra la incrustación y el traspaso del pedido funcionando de principio a fin.
Información legalCondiciones del configurador (EN) ·Contrato de encargo de tratamiento (EN) ·Aviso de privacidad para compradores ·Licencias de terceros (EN)