Como uma ferramenta de desenvolvimento de API, Postman simplifica e agiliza os fluxos de trabalho de desenvolvimento de API. Um de seus recursos mais amplamente utilizados, o OAuth 2.0, fornece uma maneira padronizada para os usuários acessarem APIs de forma segura. Neste post do blog, analisaremos mais de perto como usar o Postman OAuth 2.0 para obter um token e um exemplo envolvendo o Business Central OAuth2.
O que é OAuth 2.0?
OAuth 2.0 é um protocolo padrão da indústria para autorização que permite que um aplicativo acesse recursos de um serviço web em nome de um usuário. Ele fornece uma maneira para os usuários concederem acesso limitado aos seus recursos protegidos sem compartilhar suas credenciais.
Em vez de usar diretamente as credenciais do proprietário do recurso, o aplicativo cliente recebe um token de acesso que concede permissões específicas para acessar os recursos. Esse token permite que o aplicativo acesse contas específicas e realize ações aprovadas sem que o usuário tenha que compartilhar sua senha de conta.
Visão geral do Postman OAuth 2.0
Para começar a usar OAuth 2.0 no Postman, você precisa primeiro configurar as configurações de autorização para sua solicitação de API. Isso pode ser feito selecionando a opção "OAuth 2.0" no menu suspenso do tipo de autorização e preenchendo os detalhes necessários, como a URL de autorização e a URL do token de acesso.
Uma vez que as configurações de autorização tenham sido configuradas, você pode usar o Postman para obter um token de acesso OAuth 2.0. Isso pode ser feito enviando uma solicitação POST para a URL do token de acesso com os parâmetros necessários, como o ID do cliente e o segredo do cliente.
Um exemplo de uso das credenciais do cliente OAuth 2.0 no Postman pode ser encontrado na documentação da API do Business Central. Este exemplo mostra como obter um token de acesso usando o ID do cliente e o segredo do cliente fornecidos pelo Business Central.
Como configurar e testar OAuth2 no Postman?
Para configurar a autenticação OAuth 2.0 no Postman, siga estas etapas:
- Abra o Postman e crie uma nova solicitação.
- Clique na aba "Authorization".
3. Selecione "OAuth 2.0" como o tipo de autorização.
4. Clique no botão "Configure New Token".
5. Clique no botão "Get New Access Token".
Se a autorização for bem-sucedida, o token de acesso será exibido no campo "Access Token".
6. Use o token de acesso para fazer solicitações de API adicionando-o ao cabeçalho "Authorization" da solicitação.
Exemplos de autenticação OAuth 2.0 no Postman
Aqui estão alguns exemplos de autenticação OAuth2 no Postman:
- Para configurar a autenticação OAuth2 para o Business Central, use as seguintes informações:
- Tipo de concessão: Código de Autorização
- URL de retorno: https://www.getpostman.com/oauth2/callback
- URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
- URL do Token de Acesso: https://login.microsoftonline.com/common/oauth2/token
- ID do Cliente: O ID do cliente para o aplicativo.
- Segredo do Cliente: O segredo do cliente para o aplicativo.
- Escopo: openid
- Para configurar a autenticação OAuth2 usando credenciais do cliente, use as seguintes informações:
- Tipo de concessão: Credenciais do Cliente
- URL de Autorização: A URL para autorizar o aplicativo.
- URL do Token de Acesso: A URL para obter o token de acesso.
- ID do Cliente: O ID do cliente para o aplicativo.
- Segredo do Cliente: O segredo do cliente para o aplicativo.
- Escopo: O escopo do token de acesso.
Como obter um token de acesso OAuth 2 no Postman?
Para fazer solicitações de API usando autenticação OAuth2, primeiro precisamos obter um token de acesso. Nesta seção, aprenderemos como obter um token de acesso OAuth2 usando o Postman.
Primeiro, precisamos configurar o Postman para autenticação OAuth2. Siga as etapas na seção 2 para configurar a URL de autorização OAuth2, a URL do token, o ID do cliente e o segredo do cliente no Postman.
Uma vez que temos o Postman configurado para autenticação OAuth2, podemos obter um token de acesso enviando uma solicitação POST para a URL do token com os parâmetros apropriados. Os parâmetros necessários para a solicitação do token dependem do tipo de concessão OAuth2 que está sendo utilizada.
Por exemplo, se estivermos usando o tipo de concessão de credenciais do cliente, precisamos enviar uma solicitação POST para a URL do token com os seguintes parâmetros no corpo:
grant_type=client_credentials
client_id=<client_id>
client_secret=<client_secret>
Substitua <client_id> e <client_secret> pelos valores reais do seu cliente OAuth2.
Na próxima seção, aprenderemos como usar o token de acesso OAuth2 para fazer solicitações de API no Postman.
Como usar tokens de acesso OAuth 2.0 para solicitações de API no Postman?
Para usar tokens de acesso OAuth2 para solicitações de API no Postman, você primeiro precisa obter um token. Isso pode ser feito configurando a autorização OAuth2 no Postman.
Para fazer isso, vá até a aba de Autorização na sua solicitação e selecione "OAuth 2.0" como o tipo. Em seguida, clique em "Get New Access Token" e preencha os campos necessários, como a URL de autorização, a URL do token, o ID do cliente e o segredo do cliente.
Por exemplo, se você estiver usando o Business Central e quiser autenticar usando OAuth2 no Postman, você precisará inserir a URL de autorização como "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize" e a URL do token como "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token".
Uma vez que você obteve o token de acesso, pode usá-lo em suas solicitações de API adicionando-o ao cabeçalho de Autorização como um token Bearer.
Se você estiver usando o fluxo de credenciais do cliente OAuth 2, onde o cliente em si está autorizado a acessar a API, você pode usar o tipo de concessão "Client Credentials" no Postman. Nesse caso, você precisaria inserir o ID do cliente e o segredo do cliente nos campos apropriados e selecionar "Client Credentials" como o tipo de concessão.
Aqui está um exemplo de como usar tokens de acesso OAuth 2 no Postman:
- Configure a autorização OAuth 2 no Postman inserindo as informações necessárias.
- Clique em "Get New Access Token" para obter o token de acesso.
- Adicione o token de acesso ao cabeçalho de Autorização como um token Bearer.
- Faça sua solicitação de API usando o token de acesso.
Seguindo estas etapas, você pode autenticar facilmente suas solicitações de API usando tokens de acesso OAuth2 no Postman.
Como usar o Apidog para autorização OAuth 2.0
Apidog é uma plataforma poderosa de gerenciamento de API que suporta autorização OAuth 2.0. Com o Apidog, você pode configurar e gerenciar facilmente a autorização OAuth 2.0 para suas APIs. Ele permite que você defina escopos de autorização, credenciais de cliente e tempos de expiração de token. O Apidog simplifica a implementação de autenticação OAuth 2.0 segura em suas aplicações.
O seguinte é um exemplo de uso da autorização OAuth 2.0 no Apidog.
Passo 1. Abra o Apidog e crie uma nova API. Selecione a solicitação da API que deseja executar, como GET, PUT, POST, e insira os campos que deseja acessar.
Passo 2. Na interface da API, vá até a aba Auth e selecione OAuth 2.0.
Passo 3. Insira a interface de autorização (consumer key), interface de token (access token), ID do cliente (access token) e segredo do cliente (token secret) da interface da API.
Passo 4. Salve as alterações e teste a API.
Perguntas Frequentes sobre OAuth 2.0
Como usar OAuth 2.0 em API?
OAuth 2.0 é usado em APIs para autenticar e autorizar aplicativos de terceiros a acessar recursos protegidos em nome de um usuário. O processo envolve o envio de uma solicitação de autorização a um provedor OAuth 2.0, onde o usuário aprova as permissões, e um token de acesso é gerado que o cliente pode usar para acessar recursos protegidos.
Como funciona o OAuth 2.0 em API?
OAuth 2.0 separa a autorização da autenticação. Um aplicativo cliente envia uma solicitação de autorização a um provedor OAuth 2.0, que autentica o cliente e pede ao usuário que conceda permissão. Se concedida, o provedor gera um token de acesso que o cliente pode usar para acessar recursos protegidos.
Qual é a diferença entre OAuth 1.0 e OAuth 2.0 no Postman?
A principal diferença entre OAuth 1.0 e OAuth 2.0 no Postman é que o OAuth 2.0 fornece melhor suporte para aplicativos móveis e web com um processo de autorização mais simplificado e seguro. O OAuth 2.0 também usa SSL/TLS para comunicação, tornando-o mais seguro.
