API de Vendomia

LA API REST de Vendomia permite interactuar con los datos de tu empresa de forma programática e integrarlos con otras aplicaciones.

Todas las peticiones que se realicen a la API de Vendomia deben ser a través de la siguiente URL:

https://vendomia.app/api/

El proceso de autenticación funciona mediante un token de acceso, que se corresponde con unos de los usuarios de tu cuenta en Vendomia.

El nivel de acceso del que dispones con la API dependerá del usuario con el que accedas a ella. Los permisos otorgados según el grupo del usuario  a través de la aplicación serán los mismos durante el uso de la API.

Para autenticarse con la API, es necesario enviar el token a través de un parámetro denominado VENDOMIA_API_KEY en la cabecera de cada una de tus solicitudes.

El token de autenticación de un usuario se puede obtener en las opciones de configuración de un usuario, en la sección de Usuarios de la aplicación.

En la pestaña de Configuración, subpestaña de API, se puede obtener el token de ese usuario. Para poder utilizarlo, también es necesario habilitar el acceso mediante API.

La API hace uso de los métodos HTTP estándar (GET, POST, PUT, DELETE) para realizar la mayoría de acciones básicas sobre un endpoint determinado. En el caso de las peticiones POST y PUT, se deberá enviar un paquete de datos para poder realizar modificaciones sobre el objeto a interactuar.

Por ejemplo, en caso de interactuar con el endpoint de Contactos (contacts), se pueden realizar las siguientes peticiones:

• Obtener una lista de contactos
  GET https://vendomia/api/contacts
• Recuperar un contacto por ID
  GET https://vendomia/api/contacts/{id}
• Crear un nuevo contacto
  POST https://vendomia/api/contacts
• Modificar un contacto por ID
  PUT https://vendomia/api/contacts/{id}
• Borrar un contacto por ID
  DELETE https://vendomia/api/contacts/{id}

Algunos endpoints pueden disponer de métodos y acciones más allá de los soportados por HTTP. En estos casos, la estructura de una solicitud debe tener el siguiente formato:

POST https://vendomia/api/contacts/{id}/publish_contact