Integración de API y desarrollador
SMSEagle ofrece una poderosa API REST integrada. La API está dedicada a integrar SMSEagle con cualquier sistema externo o aplicación.
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, mantenida solo por compatibilidad hacia atrás. Una API simple HTTP y JSON-RPC. Todavía funciona y sigue siendo compatible, 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 usar 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 una clave de API v2 en su lugar.
Crear una clave
Create API key abre el formulario para la versión de API cuya página está:
Campo |
Qué hace |
|---|---|
Key name |
Cómo reconocerá esta integración más adelante, por ejemplo Zabbix o Formulario web. |
Owner |
El usuario que la clave actúa como. 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 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 qué versión de API. El distintivo enlaza directamente a la página de claves correspondiente.
Acceso a recursos de otros usuarios
Las dos versiones de API difieren en qué tan ampliamente una clave de API puede ver datos de otros usuarios:
En API v1, una clave tiene acceso por defecto a recursos de todos los demás usuarios - contactos de libreta telefónica, grupos, y así sucesivamente.
En API v2, el acceso es más granular: una clave tiene acceso por defecto solo a recursos que ella misma creó. Para permitir acceso a recursos de todos los demás usuarios, habilita Access to all users” resources en la clave.