API de Autenticação de Aplicativos
Introdução
A Autenticação de Aplicação é uma autenticação baseada em token oAuth 2.0. Um conjunto de credenciais é criado para cada DSP em cada ambiente.
❗ ❗ Ao iniciar o trabalho em uma API do DCP, precisamos solicitar acesso criando um ticket de certificação no Jira, conforme descrito na seção Atividades de Certificação com Jira. ❗ ❗
Se você já começou a trabalhar em uma API e perdeu o acesso, crie um ticket de suporte conforme descrito na seção Abrir um Ticket de Suporte.
As credenciais normalmente nunca expiram ou são revogadas (a menos que você saia do DCP).
No entanto, as credenciais podem mudar, então sua implementação deve permitir que você altere e utilize facilmente novas credenciais.
O token de acesso é válido por 30 minutos! (1799 segundos)
Por Onde Começar? Leia Isso Primeiro!
Antes de começar a trabalhar nesta API, você precisa ler as seguintes seções, caso ainda não as tenha visto:
Informações Técnicas
Características
Tipo de API | Tipo de DSP | Versão do DCP | Complexidade |
|---|---|---|---|
Obter dados do BRP | DMS | V3 - Internacional | Baixa |
Enviar dados para o BRP | CRM | V4 - América do Norte | Um pouco mais |
Transação com o BRP | | | Um pouco mais ainda |
Autenticação
Para chamar a API de Autenticação de Aplicação, você precisa do client_id e do client_secret fornecidos pela equipe DCP.
Certifique-se de usar o client_id e o client_secret correspondentes ao ambiente no qual a API está sendo chamada!
URL base
Teste | https://qa-cloud-api.brp.com/dcp |
|---|---|
Produção | https://cloud-api.brp.com/dcp |
Referência da API
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=REPLACE_ME_CLIENT_ID' \
--data-urlencode 'client_secret=REPLACE_ME_CLIENT_SECRET'curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/verify' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw ''Como Fazer
Esta seção fornece informações sobre como obter resultados específicos com a API.
Obter um Token de Acesso
Substitua o REPLACE_ME_CLIENT_ID e o REPLACE_ME_CLIENT_SECRET pelos valores correspondentes às suas credenciais no ambiente onde a chamada é feita.
Se as credenciais REPLACE_ME_CLIENT_ID e REPLACE_ME_CLIENT_SECRET forem válidas, a resposta fornecerá um access_token.
O token de acesso é válido por 30 minutos! (1799 segundos)
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=REPLACE_ME_CLIENT_ID' \
--data-urlencode 'client_secret=REPLACE_ME_CLIENT_SECRET'Verificar um Token de Acesso
Após obter seu access_token, você pode verificá-lo chamando o endpoint verify da API.
A resposta da API fornecerá o nome da aplicação se o token for válido e não estiver expirado.
curl --request POST 'https://qa-cloud-api.brp.com/dcp/authentication/app/verify' \
--header 'Authorization: Bearer REPLACE_ME_ACCESS_TOKEN' \
--data-raw ''Tratamento de Erros
Esta seção apresenta vários cenários de chamadas incorretas ou inadequadas, que resultam em mensagens de erro e resultados incorretos.
400 Solicitação Inválida
O valor de grant_type é inválido ou está ausente.
Verifique sua chamada e certifique-se de incluir o grant_type correto.
401 Não Autorizado
O código de status 401 Unauthorized geralmente é causado pelo client_id ou client_secret inválido.
Outra possível razão é que um parâmetro da requisição está ausente.
Para resolver esse problema, verifique se você está usando o conjunto de credenciais correto para o ambiente no qual está chamando a API DCP.
Consulte a seção Ambientes para obter informações sobre os ambientes disponíveis.
Requisitos DSP
Requisitos Funcionais
ID | Tipo | |
|---|---|---|
1 | Obrigatório | O access_token deve ser automaticamente renovado a cada 29 minutos |
Atividades de Certificação
Não há atividades específicas de certificação para a API de Autenticação de Aplicação; ela é validada por meio da API DCP usando Autenticação de Aplicação.
Postman
Esta seção descreve o que está disponível no Postman para explorar a API.
Ambientes
Um ambiente Postman está disponível para testar a API de Autenticação de Aplicação. Este ambiente Postman contém variáveis que são usadas pelas requisições e estão configuradas para se conectar ao ambiente de teste.
Coleções
A coleção DSP - Autenticação de Aplicação contém exemplos de chamadas para a API para obter um token de acesso e validar o token.