Versiones

General

¿Como saber la versión de la API?

El manejo de versiones de la API se hace a través de la URL de los recursos.

Por ejemplo si hace una petición a la URL:

https​://sandbox-api.openpay.co/v1/mm6wzedhck26ccaeznfa/charges/tjshfqdwd8vtbopuwyal

La versión que se está manejando es la versión 1.

Para las URL’s solo se manejan el número de versión mayor, los número de versión menor no se ocupan para efectos de compatibilidad entre actualizaciones.

¿Que cambios manejamos como compatibles entre versiones?

  • Agregar nuevos recursos en el API, por ejemplo una nueva ruta para registrar productos
  • Agregar nuevos atributos opcionales a las peticiones del API que ya existen
  • Cambio de un atributo de requerido a opcional en las peticiones que ya existen
  • Agregar nuevos atributos a las respuestas o a los webhooks que ya existen
  • Cambio en el orden de las atributos de los objetos que se responden y los que se envian en las notificaciones por webhooks
  • El formato de los identificadores pueden cambiar en cualquier momento, por ejemplo actualmente el id de tajeta inicia con k, podemos en el futuro cambiarl por l
  • Cambio de longitud en cadenas de los identificadores de los recursos (tarjetas, transacciones, clientes, etc) los cuales nunca excederán los 255 caracteres
  • Agregar nuevos tipos de notificaciones en los Webhooks

Nota: Asegúrate que este tipo de cambios en el API de Openpay son manejados de manera correcta en tu integración