Olá desenvolvedor!
Esta página é dedicada a ajudar você a consumir as APIs do Lexos Hub.
Entendendo os tipos de contas de acesso ao Lexos
São 3 tipos de conta e vamos explicar cada um deles a seguir:
Usuário
Esta conta é criada através do portal www.lexos.com.br e é destinada aos usuários finais do Lexos Hub.
Desenvolvedor
Esta conta te dá acesso a este artigo e a todo o portal de desenvolvedor que contém a documentação das APIs.
Se você está lendo este artigo, você já possui essa conta.
Aplicação
Esta conta é criada através do portal de aplicações integradas ao Lexos Hub.
Clique aqui para criar a conta da sua aplicação.
Se você está focado em desenvolver uma integração com o Lexos Hub, cada desenvolvedor do seu time deve criar uma conta para ter acesso a este portal junto com toda documentação das APIs. Todos os desenvolvedores podem utilizar a mesma conta de aplicação, entretanto, para evitar problemas com tokens de acesso, recomendamos que cada equipe de desenvolvimento crie 2 contas de aplicação, uma para que os desenvolvedores utilizem durante o desenvolvimento/testes e outra exclusiva para a aplicação de produção.
O Lexos API não possui um ambiente de homologação, por isso recomendamos que seja solicitado ao usuário do Lexos Hub a criação de produtos e anúncios de homologação.
Criação da integração no Lexos Hub
Para que a API tenha acesso aos dados do Lexos Hub, é necessário que o administrador do Hub forneça uma chave segura de autenticação da plataforma integrada, esta chave deverá ser informada no consumo de todas as APIs através do header "Chave", e para isso será necessário criar uma integração do tipo "Lexos API" na central de integrações do Hub. Este procedimento não deve ser realizado pelo desenvolvedor, mas sim pelo usuário administrador do Lexos Hub.
Acesse a ajuda do Lexos Hub para mais detalhes sobre a integração Lexos API.
Consumo das APIs
A Lexos disponibiliza para os parceiros uma série de APIs para interação com as informações gerenciadas pelo Hub. Para consumir essas informações dois pontos são necessários:
Conta de aplicação
Conta criada no portal de aplicações da Lexos. Caso esse passo ainda tenha sido feito, clique aqui.
Este procedimento deve ser feito pelo desenvolvedor.
Chave de autenticação
Chave segura fornecida pelo administrador do Lexos Hub através da criação de uma integração do tipo "Lexos API".
Este procedimento deve ser feito pelo administrador do Hub.
Processo de autenticação das APIs
O método de autenticação utilizado pelo Lexos API é o oAuth2 com Authorization Code Grant, ou seja, o fluxo é feito em duas etapas, sendo a primeira delas através do browser e a segunda através da API para obtenção do access token. Abaixo segue um passo a passo deste fluxo:
Utilizando o browser você deve acessar o endereço https://api.lexos.com.br/Autenticacao/;
Ao ser solicitado, as credenciais da aplicação devem ser fornecidas;
Após autenticação, você será redirecionado para uma outra página onde haverá o parâmetro "code" na URL.
Agora uma requisição para a API POST /Autenticacao/token deve ser realizada com o valor do "code" obtido no passo anterior no body da requisição, veja a documentação.
Se a requisição for bem sucedida, serão retornados os tokens de acesso juntamente ao seus tempos de expiração.
O access_token deve ser utilizado para todas as requisições feitas contra nossas APIs
O refresh_token deve ser utilizado para solicitar um novo access_token após a expiração do acess_token inicial
A documentação das APIs envolvidas neste processo pode ser acessada através deste link.
Processo de atualização do access_token
Após a expiração do access_token, é possível solicitar um novo através do refresh_token obtido na autenticação. Para isso é necessário enviar uma requisição para a API POST /Autenticacao/RefreshToken. A documentação deste processo pode ser encontrada neste link.