Autenticación
Para autenticarse en nuestra API, necesita una clave API. Puede crear y ver esta en su inicio de sesión en la sección de desarrolladores. Puede obtener más información en nuestro artículo de ayuda.
HTTP Basic Auth
Utilice HTTP Basic Auth con su clave API. La clave API se envía directamente como un encabezado, no es necesario realizar una codificación adicional con Base64.
Ejemplo de solicitud con HTTP Basic Auth
curl https://gateway.seven.io/api/sms \
-H 'Authorization: basic SU_CLAVE_API'
OAuth2 con Bearer Token
El requisito para la autenticación es que una aplicación esté registrada con nosotros y que el cliente la haya autorizado para usar la API.
Obtenga más información sobre OAuth2.0 →
Ejemplo de solicitud con Bearer Auth
curl https://gateway.seven.io/api/sms \
-H 'Authorization: Bearer ACCESS_TOKEN'
Autenticación mediante encabezado HTTP
Envíe su solicitud API con su clave API en el encabezado X-Api-Key
Ejemplo de solicitud con encabezado x-api-key
curl https://gateway.seven.io/api/sms \
-H 'X-Api-Key: SU_CLAVE_API'
Acceso a subcuentas
Si gestiona varias subcuentas dentro de una cuenta principal, puede usar una única clave API para actuar en nombre de cualquiera de sus subcuentas. Esto evita tener que crear una clave API separada para cada subcuenta al automatizar el aprovisionamiento.
Requisitos
- Inicio de sesión con la cuenta principal (no desde dentro de una subcuenta).
- Al crear o editar la clave API en el área de desarrollador, activar la opción «Acceso a subcuentas».
Uso
Envíe el encabezado X-Account-Id con el ID de la subcuenta de destino junto con X-Api-Key:
Enviar SMS en nombre de una subcuenta
curl -G https://gateway.seven.io/api/sms \
--data-urlencode "to=4917612345678" \
--data-urlencode "text=hello" \
-H 'X-Api-Key: SU_CLAVE_API_PRINCIPAL' \
-H 'X-Account-Id: ID_DE_LA_SUBCUENTA'
La solicitud se procesa como si proviniera de la subcuenta: el saldo, los identificadores de remitente, la configuración y las entradas del depurador pertenecen a la subcuenta y se cargan a ella. Los ámbitos de la clave principal siguen controlando qué endpoints pueden invocarse.
Notas
- La configuración de la cuenta principal (lista blanca de IPs, firma obligatoria, ámbitos) sigue aplicándose, ya que la clave pertenece a la cuenta principal.
- Los endpoints de gestión de subcuentas (p. ej.
/subaccounts) no son accesibles mientrasX-Account-Idesté definido, porque las subcuentas no pueden tener subcuentas propias. - El depurador de API registra tanto la clave utilizada (cuenta principal) como el encabezado
X-Account-Id(subcuenta de destino).
Autenticación mediante parámetros GET/POST o usuario/contraseña
Como alternativa a los métodos mencionados anteriormente, seguimos admitiendo la autenticación mediante clave API como parámetro GET o POST p.
En particular, la transmisión mediante GET no se considera segura y, por lo tanto, no debe utilizarse. Por razones de compatibilidad, también sigue siendo posible la autenticación obsoleta mediante usuario/contraseña. Se desaconseja encarecidamente su uso.
Mostrar detalles
- Name
u- Type
- string
- Optional
- Optional
- Description
Su alias de inicio de sesión o su dirección de correo electrónico. Debe proporcionarse si
pcontiene la contraseña de inicio de sesión.
- Name
p- Type
- string
- Description
Su clave API o su contraseña de inicio de sesión.
Ejemplos
HTTP GET con usuario/contraseña
curl "https://gateway.seven.io/api/endpunkt?u=IHR_LOGIN&p=IHR_PASSWORT"
HTTP GET con clave API
curl "https://gateway.seven.io/api/endpunkt?p=SU_CLAVE_API"
HTTP POST con clave API
curl -X POST "https://gateway.seven.io/api/endpunkt" \
-d "p=SU_CLAVE_API"