Authentification

Pour vous authentifier auprès de notre API, vous avez besoin d'une clé API. Vous pouvez la créer et la consulter dans votre compte dans la section Développeur. Vous pouvez en savoir plus dans notre article d'aide (en allemand).

Créer une clé API maintenant

HTTP Basic Auth

Utilisez HTTP Basic Auth avec votre clé API. La clé API est envoyée directement en tant qu'en-tête, aucun encodage Base64 supplémentaire n'est requis.

curl https://gateway.seven.io/api/sms \
  -H 'Authorization: basic VOTRE_CLÉ_API'

OAuth2 avec Bearer Token

L'authentification nécessite qu'une application soit enregistrée chez nous et que le client l'ait autorisée à utiliser l'API.

En savoir plus sur OAuth2.0 →

curl https://gateway.seven.io/api/sms \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Authentification par en-tête HTTP

Envoyez votre requête API avec votre clé API dans l'en-tête X-Api-Key

curl https://gateway.seven.io/api/sms \
  -H 'X-Api-Key: VOTRE_CLÉ_API'

Accès aux sous-comptes

Si vous gérez plusieurs sous-comptes sous un compte principal, vous pouvez utiliser une seule clé API pour agir au nom de n'importe lequel de vos sous-comptes. Cela évite de devoir créer une clé API séparée pour chaque sous-compte lors d'une automatisation.

Conditions préalables

1. Connexion avec le compte principal (pas depuis un sous-compte).
2. Lors de la création ou de la modification de la clé API dans la zone Développeur, activer l'option « Accès aux sous-comptes ».

Utilisation

Envoyez l'en-tête X-Account-Id contenant l'ID du sous-compte cible, en plus de X-Api-Key :

curl -G https://gateway.seven.io/api/sms \
  --data-urlencode "to=4917612345678" \
  --data-urlencode "text=hello" \
  -H 'X-Api-Key: VOTRE_CLÉ_API_PRINCIPALE' \
  -H 'X-Account-Id: ID_DU_SOUS_COMPTE'

La requête est traitée comme si elle provenait du sous-compte : le solde, les identifiants d'expéditeur, les paramètres et les entrées du débogueur appartiennent au sous-compte et lui sont facturés. Les portées de la clé principale continuent de contrôler les points de terminaison accessibles.

Remarques

• Les configurations du compte principal (liste blanche IP, exigence de signature, portées) restent actives, car la clé appartient au compte principal.
• Les points de terminaison de gestion des sous-comptes (par ex. /subaccounts) ne sont pas accessibles lorsque X-Account-Id est défini, car les sous-comptes ne peuvent pas posséder de sous-comptes.
• Le débogueur d'API enregistre à la fois la clé utilisée (compte principal) et l'en-tête X-Account-Id (sous-compte cible).

Authentification par paramètre GET/POST ou utilisateur/mot de passe

En alternative aux méthodes mentionnées ci-dessus, nous continuons à prendre en charge l'authentification par clé API en tant que paramètre GET ou POST p.

La transmission par GET en particulier est considérée comme non sécurisée et ne doit donc pas être utilisée. Pour des raisons de compatibilité, l'authentification obsolète par utilisateur/mot de passe est également toujours possible. Ceci est fortement déconseillé.

curl "https://gateway.seven.io/api/endpoint?u=VOTRE_LOGIN&p=VOTRE_MOT_DE_PASSE"

curl "https://gateway.seven.io/api/endpoint?p=VOTRE_CLÉ_API"

curl -X POST "https://gateway.seven.io/api/endpoint" \
    -d "p=VOTRE_CLÉ_API"