Descripción general de la API Encantaap

Conceptos básicos de la API de contenido de Encantaap

La API de contenido de Encantapp te da acceso a las funciones de gestión de contenido que ves en nuestra aplicación web y te permite ampliarlas para usarlas en tu propia aplicación. Su principio de funcionamiento es RESTful y se organiza en torno a los principales recursos que ya conoces de la interfaz web de Encantapp

Antes de hacer cualquier cosa, debe crear una cuenta gratuita de Encantaap con la que pueda probar la API de Encantapp y registrarse para obtener una clave API para poder realizar llamadas API.

Solicitudes de ejemplo

Ante cada método se proporcionan ejemplos de llamadas a la API que utilizan cURL , una herramienta estándar de línea de comandos. Solo tienes que introducir tus parámetros específicos y podrás probar las llamadas desde la línea de comandos. Aquí tienes un excelente tutorial sobre el uso de cURL con API . Si la línea de comandos no te convence, una excelente alternativa es POSTMAN , una extensión de Chrome fácil de usar para realizar solicitudes HTTP.

Formato de entrada/salida

Tanto los datos del cuerpo de la solicitud como los datos de respuesta tienen formato JSON .

Formato de fecha de la API

Todas las marcas de tiempo (tanto las enviadas en las solicitudes como las devueltas en las respuestas) deben tener el formato que se muestra en nuestros ejemplos. Admitimos las marcas de tiempo RFC 3339. La mejor manera de pasar una fecha es convertirla a UTC, como en este ejemplo: 2013-04-17T09:12:36-00:00

gzip

Si desea que las respuestas de Encantapp se compriman para tiempos de respuesta más rápidos, simplemente incluya un encabezado Accept-Encoding con un valor de gzip, deflate y las respuestas se comprimirán .

CORS

CORS , o intercambio de recursos entre orígenes, es un mecanismo que permite que una página web realice solicitudes XMLHttpRequest a otro dominio (es decir, a un dominio diferente del que se cargó). CORS es compatible con un conjunto específico de navegadores modernos . La API de Encantapp es compatible con CORS.

Paginación

Los puntos finales que devuelven matrices admiten los parámetros de URL "limit" y "offset" . "Limit" define el número máximo de registros que se devolverán en una página. No se garantiza que el número de registros sea el especificado, ya que las reglas de visibilidad pueden filtrar elementos. Para evitar la devolución de duplicados, recomendamos la siguiente lógica:

• Para recuperar la página siguiente, establezca offset=offset+limit

• Si el recuento total de la respuesta anterior es >= el nuevo desplazamiento, ya está listo, no es necesario solicitar otra página.

Tenga en cuenta que el desplazamiento se basa en cero y los valores predeterminados para el límite varían según el punto final.

Próximos cambios

Mantenemos, corregimos y mejoramos constantemente nuestra API de Encantapp. Por ello, es de esperar que aparezcan nuevos endpoints, nuevos campos en las respuestas y nuevos códigos de error. Le recomendamos que configure su código para que ignore con precisión los elementos inesperados y gestione los errores de forma estándar, centrada en HTTP.