Funcionamiento de la API pública de Escala
Usuarios autorizados: Administradores.
La misión: Conoce cómo funciona la API pública de Escala.
1. ¿Qué es una API?
API significa Application Programming Interface, que traducido al español es una interfaz de programación de una aplicación. Las API son mecanismos creados para que un sistema se comunique con otro.
En Escala, la comunicación entre sistemas o aplicaciones ocurre en un solo sentido y debe comenzar por parte del sistema externo. Próximamente, se implementarán webhooks para que Escala pueda iniciar la comunicación hacia los sistemas externos. Sin embargo, hay una manera de programar el sistema externo para que hagas la solicitud de la información que requiere que Escala envíe.
2. Requerimientos técnicos para utilizar una API en Escala
Para utilizar nuestra API, debes:
- Ser cliente de Escala.
- Tener un responsable de programación en tu equipo para que puedas implementar tu caso de uso particular.
- Ir a la sección Mi cuenta > Perfil y configuraciones > Integraciones y crear una API Key para autenticar las peticiones que hagas.
Por otra parte, la persona responsable de las API debe cumplir con lo siguiente:
- Puede ser un programador, quien leyendo la documentación puede implementar las peticiones.
- Debe tener conocimientos sobre, al menos, un lenguaje de programación. Sin embargo, para resolver casos particulares podría ser necesario que conozca varios.
- Cualquier lenguaje de programación que permita hacer peticiones a APIs y que se ajuste al resto del entorno de desarrollo específico al cliente.
3. Función de API Key
La API Key es única y permite identificar tu cuenta, como si cumpliera la función de un usuario y contraseña, para la autenticación del usuario al utilizar un servicio.
De esta forma, el responsable de programación en tu equipo podrá conectarse vía API para usarla con tu autorización.
3.1 Para conocer tu API Key en Escala, dirígete al ícono de cuenta y haz clic en Perfil y configuraciones.3.2 Luego, busca la sección de CRM y haz clic en Integraciones.3.3 En esta ventana encontrarás la integración de la API de Escala, donde podrás copiar la API Key.
4. Límites de la API Key de Escala
Escala le aplica límites a la API Key, que se definen como soft limits y son los siguientes:
- Request: 500.000 peticiones al día.
- Rate: 15 peticiones por segundo
- 50 burst
5. Operaciones en Escala con API
En Escala, tenemos varias entidades y por cada una se permiten un grupo de operaciones diferentes. La API es la encargada de brindar el acceso a esas entidades (como contactos, usuarios, etiquetas) para ejecutar operaciones disponibles. Actualmente, algunas de las entidades y grupos disponibles son:
- Buscar contacto
- Crear contacto
- Crear o actualizar contacto
- Eliminar contacto
- Actualizar contacto
- Actualizar etiquetas de un contacto
Campos personalizados:
- Buscar campos personalizados
Etiquetas:
- Buscar etiquetas
- Crear etiquetas
6. API y la funcionalidad de Automatización
Por defecto, en Escala ninguno de los métodos disparan un flujo automatizado configurado en nuestra plataforma. Sin embargo, si lo deseas, es posible hacer que se active un flujo automatizado al llamar a una operación mediante un parámetro que se le pasa.
7. Permisos
En cuanto a permisos, es importante tener en cuenta que la API Key tiene privilegios administrativos en aquellas operaciones disponibles, es decir, las operaciones actúan como si fuera un administrador.
8. Versiones de la API
Actualmente, la API de Escala se presenta en su primera versión (V1). Sin embargo, a futuro lanzaremos nuevas versiones y te notificaremos, por diversos medios, cada vez que esto ocurra.
Es importante tener en cuenta que cada versión tendrá una fecha límite de soporte y cada vez que haya el lanzamiento de una nueva versión, se mantendrá compatibilidad retroactiva por 3 meses con la versión anterior.
Esto te servirá de referencia para que sepas cuánto tiempo seguirá funcionando una versión de la API y cuándo deberás actualizarla.
¿Estás listo para completar la misión en Escala?