Este artigo explica como usar as APIs na DevZone com EloView 4
Abaixo descreve como usar APIs na Elo DevZone. Este artigo abrange o seguinte:
1. Gerar Credenciais OAuth
2. Obter token de autenticação
3. Autorizar APIs
4. Obter OrgId:
5. Executar API
1. Gerar Credenciais OAuth
OAuth (Open Authorization) é um protocolo de autorização de padrão aberto que fornece às aplicações a capacidade de “acesso designado seguro”. Isso será usado para obter o token de autorização.
a. Faça login no site EloView: https://secure.eloview.com/
b. Clique no ícone de perfil
c. Clique em Gerar credenciais OAuth
d. Copie e cole as Credenciais OAuth (clientID e clientSecret) em um bloco de notas, então clique em OK
2. Obter token de autenticação
Esse é o processo de autenticação de usuários ou processos para aplicações na nuvem. A aplicação do usuário envia um pedido para o serviço de autenticação, que confirma a identidade do usuário e emite um token. O usuário então pode acessar a aplicação.
a. Clique na aba APIs
b. Expanda a grade de autenticação e clique no botão “Tente agora” (mostrado na imagem abaixo), isso permitirá que você insira valores para os parâmetros necessários e mostrará o botão de executar na parte inferior da caixa da API.
c. Adicione Client Id (parâmetro de caminho) e clientsecret como parâmetro de corpo (recebido das Credenciais OAuth / Etapa 1) e então clique em executar.
d. Isso fornecerá o token de autenticação que pode ser usado em operações futuras.
e. Verifique o corpo da resposta e copie o access_token da resposta. Isso será usado como token Bearer para acessar as outras APIs. A resposta parecerá com a imagem abaixo.
3. Autorizar APIs
Tokens de acesso são a coisa que as aplicações usam para fazer pedidos de API em nome de um usuário. O token de acesso representa a autorização de uma aplicação específica para acessar partes específicas dos dados de um usuário.
a Clique no botão Autorizar localizado no canto superior direito da tela.
b Isso abrirá um diálogo de onde podemos adicionar o valor do token de acesso para autorizar as APIs.
c. Digite bearer & cole o token de acesso no campo de entrada.
d. Clique no botão Autorizar & feche o pop-up
e. Agora o usuário está autorizado a acessar qualquer API disponível.
4. Obter OrgId:
OrgId (ID da organização) será usado para realizar diferentes ações de API a partir da Dev-zone.
a. Clique no ícone de engrenagem
b. O OrgId está no canto inferior direito
5. Executar API
Uma vez que a autorização esteja completa, podemos executar as APIs da dev-zone.
a. Expanda o módulo, por exemplo, Conteúdo / Obter lista de conteúdo
b. Clique em Tente agora
c. Digite ORG ID
d. Selecione Executar
Os resultados devem parecer assim:
Please report any broken links by emailing support@elotouch.com and include a link to the knowledge article