OAuth 2.0
O acesso à API exigirá autenticação OAuth 2.0 que, por sua vez, exigirá usuário técnico para um distribuidor específico no sistema de autenticação Schneider.
Para solicitar credenciais, envie um email para: distribuidorapiportal.global@se.com
Como o OAuth funciona:
- O usuário da API precisa ter um ID de cliente estático e uma chave secreta junto com o endpoint de geração de token do provedor de API.
- Usando os detalhes acima, a API Token precisa ser chamada com o método POST.
- Essa API retornará o token Bearer, que pode ser usado por 1 hora para chamar a API, isso pode ser tratado como credencial dinâmica que tem validade de uma hora.
Meio Ambiente | Endpoint de geração de token |
Explorar | https://api.explore.se.com/token |
Dev | https://api.dev.se.com/token |
QA | https://api.qa.se.com/token |
Pre-prod | https://api.preprod.se.com/token |
Production | https://api.se.com/token |
Como gerar token usando o Postman:
- Criar nova solicitação de API com endpoint de API real
- Vá para a seção Autorização
- Selecione o tipo como OAuth 2.0
- No lado direito, vá para Configurar Novo Token
- O nome do token pode ser definido pelo usuário (por exemplo, nome do distribuidor)
- Tipo de concessão = Credenciais do cliente (selecione na lista suspensa)
- A URL do token de acesso será conforme a tabela acima
- O ID do cliente e o segredo do cliente serão fornecidos pela equipe da Schneider
- Escopo todos
- A autenticação do cliente pode ser Enviar credenciais do cliente no corpo
- Clique em Obter novo token de acesso
Amostra de geração de token usando a nova solicitação do Postman:
Selecione POST e insira a URL do token.
Na guia Corpo, clique no botão de opção x-www-form-urlencoded.
Insira manualmente a Chave e o Valor, “grant_type” e “client_credentials”.
Na guia Autorização, selecione Tipo “Autenticação básica”.
Defina o nome de usuário para a chave do cliente (fornecida offline).
Defina a senha para o segredo do cliente (fornecido a você offline).
Envie a solicitação e recupere o valor de access_token da mensagem de resposta.
Criação de solicitação de geração de token usando CURL no Postman:
No carteiro, selecione a opção Importar (que fica no canto superior esquerdo).
Na caixa de diálogo Importar, selecione Texto bruto e cole a amostra de curvatura fornecida abaixo.
Clique em Continuar e depois em Importar.
Na guia Headers, substitua o valor Authorization pela string codificada em Base-64 de client_key e client_secret.
Exemplo de curl para geração de token:
curl --location --request POST 'https://api.se.com/token' \
--header 'Authorization: Basic askjdfsaldalskjfdlsajflasdkjfb2h4NVJxMFlSZ2hUbA==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'
Chave API
Para algumas APIs, o acesso usando a chave de API também é viável quando você fornece a apikey de longa duração como um parâmetro de consulta.
Depois de ter um apikey, você pode exercer operações GET diretamente em um navegador da web.
Formato de URL: https://{hostname}/{BaseURL}/{ResourcePath}?{queryParams}&apikey={your_api-key}