La API de Clip sigue los principios REST para el desarrollo de APIs y se comunica a través de llamadas y respuestas en formato JSON.
Métodos HTTP
La API de Clip está habilitada para comunicarse utilizando los siguientes métodos HTTP:
- GET: Una llamada GET te permite obtener información de tu cuenta o aplicación.
- POST: Una llamada POST te permite crear elementos nuevos en tu cuenta o aplicación.
- DELETE: Una llamada DELETE permite eliminar elementos de tu aplicación.
Respuestas
La API de Clip está desarrollada para regresar códigos de respuesta HTTP estándar. Todas las respuestas con código 200 incluyen un objeto JSON con la información solicitada (llamadas GET) o con un mensaje descriptivo de confirmación (llamadas POST).
Errores
Las herramientas de Clip regresan códigos estándar de error cuando algo no ocurre de la forma esperada y están documentados a detalle en la sección de referencia técnica.
Las APIs regresan códigos de error HTTP acompañados por un objeto JSON con los detalles del error.
Los SDK regresan un código de error acompañado por una descripción del error.
Pruebas
Para realizar pruebas iniciales con la API de Clip puedes utilizar cualquier herramienta que permita trabajar con APIs HTTP, como Postman. Para poder realizar llamadas de prueba es necesario obtener un token de autenticación.