Integración de API y Desarrollo
SMSEagle ofrece una potente 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 toda 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 HTTP y JSON-RPC simple. Todavía funciona y sigue siendo compatible, pero no recibe nuevas funciones - no escriba nuevas integraciones contra ella. Referencia de API v1
Debido al contenido extenso de la documentación de 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 separadas 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 para solo lectura mientras que un formulario web solo puede 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 una clave de API v2 en su lugar.
Crear una clave
Create API key abre el formulario para la versión de API en cuya página se encuentra:
Campo |
Lo que hace |
|---|---|
Key name |
Cómo reconocerá esta integración más adelante, por ejemplo Zabbix o Website form. |
Owner |
El usuario en 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 (véase más abajo). |
Permisos |
Solo los métodos que actives pueden ser llamados 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 API tiene el usuario y para qué 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 la API difieren en cuán ampliamente una clave de API puede ver los datos de otros usuarios:
En API v1, una clave tiene acceso por defecto a recursos de todos los demás usuarios - contactos de directorio, grupos, etc.
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.