API e Integración de Desarrolladores
SMSEagle ofrece una potente API REST integrada. La API está dedicada a integrar SMSEagle con cualquier sistema o aplicación externa.
Referencia de API
SMSEagle ofrece dos versiones de API:
API v2 - recomendada, úsela para cada nueva integración. Una API RESTful moderna basada en la especificación OpenAPI 3.0. Referencia de API v2
API v1 - la API heredada, conservada solo por compatibilidad hacia atrás. Una API simple HTTP y JSON-RPC. Sigue funcionando y se sigue admitiendo, pero no recibe nuevas características - no escriba nuevas integraciones contra ella. Referencia de API v1
Debido al contenido extenso de la documentación de la API, se mantiene como un documento separado. Siga los enlaces anteriores para la especificación completa de cada API.
Claves de API
Una integración se autentica con una clave de API en lugar de una contraseña de usuario. Las claves se mantienen por separado para cada versión de API, en dos páginas:
Settings > API > API v2 (
/settings/api/v2)Settings > API > API v1 (
/settings/api/v1)
Una clave siempre pertenece a un usuario y actúa como ese usuario, por lo que ve los mensajes y contactos de ese usuario. Los permisos se otorgan por clave, lo que le permite limitar un sistema de monitoreo a solo lectura mientras que un formulario web puede solo enviar.
Claves de API v2
Esta es la página a utilizar para una nueva integración.
Claves de API v1
API v1 es la API heredada. Cree una clave v1 solo para una integración existente que no pueda migrarse a v2 - para cualquier cosa nueva, cree en su lugar una clave de API v2.
Creación de una clave
Create API key abre el formulario para la versión de API en la que se encuentra:
Campo |
Qué hace |
|---|---|
Key name |
Cómo reconocerá esta integración más tarde, por ejemplo Zabbix o Website form. |
Owner |
El usuario en cuanto el que actúa la clave. La clave ve los mensajes y contactos de ese usuario. |
Key enabled |
Una clave deshabilitada es rechazada por la API sin ser eliminada, lo que desactiva una integración sin perder su configuración. |
Access to all users” resources |
Solo API v2. Permite que la clave lea y cambie recursos propiedad de otros usuarios (ver abajo). |
Permisos |
Solo se pueden llamar los métodos que actives con esta clave. |
La clave en sí se muestra una sola vez, justo después de crearla. Cópiala entonces y guárdala en un lugar seguro. Si la pierdes, revoca esa clave y crea una nueva; las otras claves del mismo usuario seguirán funcionando.
Qué usuarios tienen acceso a la API
System > Users muestra, por usuario, cuántas claves de API tiene el usuario y para cuál versión de API. El distintivo enlaza directamente a la página de claves correspondiente.
Acceso a la API, mostrado por usuario en la lista de usuarios
Acceso a recursos de otros usuarios
Las dos versiones de API difieren en cuán ampliamente una clave de API puede ver datos de otros usuarios:
En API v1, una clave tiene acceso por defecto a recursos de cualquier otro usuario: contactos de libreta de direcciones, grupos, etc.
En API v2, el acceso es más granular: una clave tiene acceso por defecto solo a recursos que creó ella misma. Para permitir acceso a recursos de todos los demás usuarios, habilita Access to all users” resources en la clave.