Documentación API

El uso de esta API está restringido a programadores y gente con conocimientos tecnológicos avanzados. Cualquier funcionalidad que se quiera realizar a través de la API se puede realizar también a través de la interfaz web, por lo que si no posees conocimiento tecnológico, intenta utilizar la interfaz web.

Para poder autentificarse contra nuestra API se necesita el auth token. Ten en cuenta que solo verás esta información si estás logeado en la página y que estos datos son exclusivos de tu cuenta y no personales, no los compartas con nadie ajeno a tu organización. Todas tus llamadas deben incluir:

Debes estar logueado para ver estos valores Entra aquí.

Nuestra API es de formato REST, por lo que es independiente del lenguaje que se vaya a utilizar. Las llamadas siempre se realizan sobre el siguiente endpoint:

https://acumbamail.com/api/1/(nombreFuncion)/

Y a este endpoint es al que se le pasarán los parámetros de entrada. Nuestra recomendación, dado que en la mayoría de los casos se van a realizar modificaciones sobre los datos que están almacenados en la base de datos es que se utilice POST, aunque también tenemos capacidad para soportar llamadas en formato GET.

Todas las funciones, además de los datos que puedan devolver como respuesta a la petición, también devolverán un código de estado de html que podremos capturar. Hay un código distinto para cada situación y son los siguientes:

• Código de estado

• 200

  La consulta ha ido bien

• 201

  Los datos se han modificado correctamente

• 400

  Petición incorrecta: algún argumento ha sido incorrecto

• 401

  No autorizado, el proceso de autenticación ha sido incorrecto

• 429

  Demasiadas peticiones a una función en un periodo de tiempo

• 500

  Se ha producido algún error en el servidor. Infórmanos para que lo arreglemos

En algunos casos se pide un diccionario como parámetro de entrada para los métodos. En el caso de llamadas POST todos los parámetros deben ir en el body como form-data, para codificar un diccionario en llamada GET un ejemplo sería:

https://acumbamail.com/api/1/(nombreFuncion)/?dict[key]=value&dict[key1]=value1&dict[key2]=value2

Y a este endpoint es al que se le pasarán los parámetros de entrada. Nuestra recomendación, dado que en la mayoría de los casos se van a realizar modificaciones sobre los datos que están almacenados en la base de datos es que se utilice POST, aunque también tenemos capacidad para soportar llamadas en formato GET.