API de Tribu

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

Como servicio REST, la API permite acceder a la mayoría de acciones que se realizan a través de la interfaz de Tribu. Su uso se podría clasificar en algunos métodos principales:

• Obtener una lista de objetos
• Obtener un objeto
• Crear, modificar o borrar un objeto
• Realizar una acción especial

El uso de la API de Tribu es ideal cuando se desea acceder a la información de forma proactiva-- es decir, la iniciativa de una acción ocurre por parte del cliente.

Un ejemplo de esto es consultar la base de datos de Tribu para recuperar información específica-- un objeto o una lista de objetos.

La API también permite realizar modificaciones en Tribu de forma programática. Si por ejemplo deseas realizar integraciones, automatizaciones, o implementar cambios en Tribu, la API es ideal para ello.

Por otro lado, el uso de la API no es ideal cuando se desea realizar una sincronización desde Tribu hacia otra aplicación. Hacer esto normalmente implica consultar de forma repetida e ineficiente los últimos cambios realizados en Tribu, por lo que resulta ser un desperdicio de recursos.

En lugar de eso, se recomienda hacer uso de los webhooks.

La API Rest de Tribu está diseñada especialmente para interactuar con tus datos cuando sea necesario. Por ejemplo, cuando ocurre un evento en una aplicación externa.

 Por el contrario, los webhooks se ejecutan cuando ocurre una acción o evento concretos en Tribu, enviando de forma automática los datos del objeto afectado a una URL de tu elección.

En otras palabras:

• La API permite consultar información de Tribu desde fuera.
• La API también permite hacer cambios con iniciativa desde fuera.
• Los webhooks mandan información hacia afuera cuando ocurre algo en Tribu.

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

https://app.tribu.one/api/

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

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 TRIBU_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://app.tribu.one/api/contacts
• Recuperar un contacto por ID
  GET https://app.tribu.one/api/contacts/{id}
• Crear un nuevo contacto
  POST https://app.tribu.one/api/contacts
• Modificar un contacto por ID
  PUT https://app.tribu.one/api/contacts/{id}
• Borrar un contacto por ID
  DELETE https://app.tribu.one/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://app.tribu.one/api/contacts/{id}/publish_contact