Autenticação

Token de Acesso

O primeiro passo para consumir a API e seus métodos é obter um token de acesso a partir do "Client ID", "Client Secret" e "Subscription Key" enviados previamente.

Endpoint para geração do token de acesso => {URL}/access-token

Existem dois tipos de token de acesso: Participante e Aplicação.

Token de acesso do tipo Aplicação

O token de acesso do tipo aplicação é utilizado inicialmente para cadastrar novos participantes e/ou recuperar senha de um participante. Clique aqui para um exemplo.

Exemplo:

Chamada via POST

POST {URL}/access-token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: {URL}
Authorization: Basic Base64(client_id:client_secret)
Ocp-Apim-Subscription-Key: {subscription-key}
grant_type=client_credentials&campaign_id={campaign_id}

Retorno

{
     "access_token": "ae4qffHxXNPo9U6u4DUsuqfxJlr3C3Ms9qxf8Sr8h8...",
     "token_type": "bearer",
     "expires_in": "3600"
}

Token de acesso do tipo Participante

O token de acesso do tipo participante é utilizado para todos os casos onde os dados necessários para geração do token são conhecidos. Clique aqui para um exemplo.

Exemplo:

Chamada via POST

POST {URL}/access-token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: {URL}
Authorization: Basic Base64(client_id:client_secret)
Ocp-Apim-Subscription-Key: {subscription-key}
grant_type=password&username={username}&password={password}&campaign_id={campaign_id}

Retorno

{
     "access_token": "ywfBff4e9Vv0cEUPCLEDdYaOqnlu8sJiHfRnEPnz...",
     "token_type": "bearer",
     "expires_in": "3600"
}

O token retornado no campo {"access_token"} será necessário em todas as requisições que vierem a ser feitas.

O parâmetro {"Authorization"} é composto do "client_id" e do "client_secret" da APP que são concatenados com ":" (dois pontos) e convertidos para Base64.

Para informar o parâmetro {"Authorization"} no header da chamada utilize este exemplo:

Authorization: Basic YjVjNzhyODVoMkU4NjloNzg5NjU0YpIwcXdlODdzMzoxnjM0DQo=

Consumindo os Serviços

Para consumir os serviços da API, é necessário enviar o "Ocp-Apim-Subscription-Key" da APP no cabeçalho da cada requisição (Header’s), assim como o "Authorization" que será o conteúdo do retorno do "access-token" da rota de geração do token.

Exemplo:

Ocp-Apim-Subscription-Key: {subscription-key}
Authorization: "Bearer {access-token}"