Authentication

To authenticate to our API, you need an API key. You can create and view this in your login in the Developer area. You can find out more about this in our Help article.

Create API key now

HTTP Basic Auth

Use HTTP Basic Auth with your API key. The API key is sent directly as a header, further encoding via Base64 is not required.

Example request with HTTP Basic Auth

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

OAuth2 with Bearer Token

The prerequisite for authentication is that an app is registered with us and the customer has authorized it to use the API.

Learn more about OAuth2.0 →

Example request with Bearer Auth

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

Authentication via HTTP header

Send your API request with your API key in the X-Api-Key header

Example request with x-api-key header

curl https://gateway.seven.io/api/sms \
  -H 'X-Api key: YOUR_API_KEY'

Deprecated

Authentication via GET/POST parameter or user/password

As an alternative to the above methods, we continue to support authentication via API key as GET or POST parameter p.

Transmission via GET in particular is not considered secure and should therefore not be used. For compatibility reasons, the deprecated authentication by user/password is still possible. This is strongly discouraged.

Show details

Name
u
Type
string
Optional
Optional
Description
Your login alias or your e-mail address. Must be entered if p contains the login password.
Name
p
Type
string
Description
Your API key or your login password.

Examples

HTTP GET with user/password

curl "https://gateway.seven.io/api/endpunkt?u=IHR_LOGIN&p=IHR_PASSWORT"

HTTP GET with API key

curl "https://gateway.seven.io/api/endpunkt?p=YOUR_API_KEY"

HTTP POST with API key

curl -X POST "https://gateway.seven.io/api/endpunkt" \
  -d "p=your_api_key"