El nuevo API de Culqi

Los últimos meses hemos estado trabajando en la nueva versión del API de Culqi, y creemos que es tiempo de mostrarles lo que tenemos hasta ahora. Hemos realizado grandes cambios estructurales, ahora tenemos nuevos endpoints, recursos, funcionalidades avanzadas y necesitamos que nos digan lo que piensan. Todas sus sugerencias son bienvenidas para seguir brindándoles el mejor servicio.

¿Qué ha cambiado?

Mucho. Hemos implementando un buen grupo de endpoints, que te permitirán obtener más información antes no accesible y realizar nuevas operaciones, que simplificarán tus desarrollos y te permitirán reducir el tiempo de integración para crear las soluciones que imagines.

Ahora todos nuestros endpoints. se rigen por estándar de HTTP Methods, al usar los verbos GET, POST, PATCH, DELETE. Usamos GET para consultar recursos, POST para crearlo, PATCH para actualizarlos y DELETE para eliminarlos. Las peticiones realizadas y las respuestas son JSON. Ya no tendrás respuestas vacías o en formatos distintos, nos vamos a asegurar que cualquier interacción tenga una respuesta de nuestra parte.

Tratamos que los nuevos recursos, respuestas y operaciones, tengan consistencia en todo momento. Velamos por que sean fáciles de entender y no usar términos complejos o explicaciones largas, con el fin que la experiencia de integración sea lo más grata posible.

En el manejo de errores, estamos usando HTTP Status Codes, para indicar lo que ha sucedido en cada operación. Si un recurso fue creado exitosamente retornamos 201, por peticiones erróneas 400, si no usas el header de autenticación 401, y si algo va mal en Culqi 500 :( , etc..

En el caso de soporte, tenemos nuevas formas de identificar tus problemas y consultas rápidamente. Esperamos que con esto puedes sentirte a gusto usando Culqi, y no causarte incomodidades al momento de contactarnos.

Tenemos siempre en cuenta las sugerencias que nos brinda la comunidad y por lo tanto hemos cambiado el idioma de todos nuestros parámetros a inglés, lo que permitirá a los desarrolladores familiarizarse con mayor facilidad y además nos abre las puertas a un mercado mucho más grande.

Con todos estos cambios, esperamos que el API de Culqi sea más fácil de usar y entender. Esperamos también que sea más facil para los desarrolladores crear nuevas soluciones, integraciones y bibliotecas para hacer crecer nuestra comunidad.

Nuevos Recursos

Los nuevos recursos con los que trabajaremos son:

Tokens

Un token representa la tarjeta de tu cliente, puedes guardarlo para realizar cargos posteriores.

Charges

El cargo se crea cuando se realiza el cargo a la tarjeta del cliente.

Plans

Un plan define la manera como se realizarán cargos recurrentes a tu cliente.

Subscriptions

La suscripción te permite realizar cargos recurrentes a tu cliente, usando un token y un plan.

Refunds

Te permite devolver parcial o totalmente un cargo.

Para tener más información, sobre los nuevos recursos, peticiones y respuestas, revisa la pagina de la referencia.

Dejando ir

El API v2 de Culqi es un gran cambio, y con grandes cambios siempre hay algo que tenemos que dejar atrás. Al lanzar la versión “oficial” del nuevo API de Culqi la v1 dejará de ser actualizada, y construiremos nuevas funcionalidades y productos sobre esta nueva base. La v2 del API es el futuro de Culqi y esperamos que todos usen esta versión para tener lo mejor de nosotros.

En las próximas semanas, estaremos lanzando más información acerca de la migración, guías de ayuda y otros recursos que harán que la transición se lo más simple posible.

¡Pruébenla!

Tenemos unos endpoints que ya puedes probar. Necesitarás haber actualizado tus llaves y código de comercio a la nueva versión. Si no tienes una cuenta aún, no te preocupes, es muy sencillo crearla aquí.

Actualizando al API v2

Para realizar esta actualización debes de:

1. Ingresar al panel de Integración de Culqi.
2. Dirigirte a la sección Desarrolladores -> API Keys.
3. Encontrar el botón Actualizar API v2 y darle click. Una vez que hayas confirmado la actualización. Tendrás nuevas llaves y código de comercio.

Al dar click en Actualizar al API v2 y aceptar la confirmación tendrás las nuevas llaves para el API v2.

Si todo se realizó correctamente, tendrás nuevas llaves y la antigua quedará como inactiva. Recuerda que una vez hayas actualizado a la nueva versión del API, no podrás volver a la v1.

Se habrán generado dos nuevas llaves, el código de comercio se habrá renovado como la llave pública y tu llave será la nueva llave privada.

Eso es todo, con tus nuevas llaves podrás probar la integración y los nuevos endpoints.

Para probar el nuevo API tienes varias opciones:

• Usar algún cliente REST, puedes usar PostMan, Soap UI, entre otros y usar la referencia del API.
• Usar nuestra biblioteca en PHP. Puedes usar el branch Develop, donde está la biblioteca actualizada con el nuevo API. Y además tenemos un ejemplo donde puedes probar un flujo completo.
• Usar el lenguaje que desees, y hacer tu propio cliente. Esta es la referencia del API, úsala para guiarte sobre las peticiones y respuestas.

Finalmente

Por favor, recuerda que esta es una versión Beta y algunas cosas pueden cambiar. Por el momento la v2, se puede usar solo en nuestro ambiente de pruebas.

Estamos muy interesados en lo que piensen, si tienes feedback, dudas o simplemente quieres comunicarte con nosotros acerca del nuevo API, envíanos un correo a william.muro@culqi.com con el asunto API V2 o puedes visitarnos en nuestras oficinas.