Autenticação

Para autenticar-se em nossa API, você precisa de uma chave de API. Você pode criar e visualizar essa chave na seção de desenvolvedores do seu login. Saiba mais em nosso artigo de ajuda.

Criar chave de API agora

HTTP Basic Auth

Use HTTP Basic Auth com sua chave de API. A chave de API é enviada diretamente como um cabeçalho, não é necessário codificá-la em Base64.

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

OAuth2 com Bearer Token

A autenticação requer que um aplicativo esteja registrado conosco e que o cliente tenha autorizado seu uso da API.

Saiba mais sobre OAuth2.0 →

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

Autenticação por HTTP Header

Envie sua requisição API com sua chave de API no cabeçalho X-Api-Key

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

Acesso a subcontas

Se você gerencia várias subcontas em uma conta principal, pode usar uma única chave de API para agir em nome de qualquer uma das suas subcontas. Isso evita ter que criar uma chave de API separada para cada subconta ao automatizar o provisionamento.

Pré-requisitos

1. Login na conta principal (não a partir de uma subconta).
2. Ao criar ou editar a chave de API na área do desenvolvedor, ative a opção "Acesso a subcontas".

Uso

Envie o cabeçalho X-Account-Id contendo o ID da subconta de destino junto com X-Api-Key:

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

A requisição é processada como se viesse da subconta: saldo, identificadores de remetente, configurações e entradas do depurador pertencem à subconta e são debitados dela. Os escopos da chave principal continuam a determinar quais endpoints podem ser chamados.

Notas

• As configurações da conta principal (lista de IPs permitidos, exigência de assinatura, escopos) continuam ativas, pois a chave pertence à conta principal.
• Endpoints de gestão de subcontas (p. ex. /subaccounts) não são acessíveis quando X-Account-Id está definido, pois subcontas não podem ter subcontas próprias.
• O depurador da API registra tanto a chave usada (conta principal) quanto o cabeçalho X-Account-Id (subconta de destino).

Autenticação por parâmetro GET/POST ou usuário/senha

Como alternativa aos métodos mencionados acima, ainda suportamos a autenticação por chave de API como parâmetro GET ou POST p.

Especificamente, a transmissão via GET não é considerada segura e, portanto, não deve ser usada. Por razões de compatibilidade, a autenticação obsoleta por usuário/senha ainda é possível. Isso é fortemente desencorajado.

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

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

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