Autenticação do chat na API olx.com.br
Autenticação e Autorização
Para realizar a integração de chat, é necessário que o cliente autorize no portal OLX que o integrador administre suas mensagens de chat. Portanto, deve ser solicitado a inclusão do scope chat ao access-token.
Para criação de um access_token, siga essa documentação.
Requisição
A autorização é requisitada pelo Integrador ao realizar a abertura de uma página no navegador incluindo parâmetros que indicam o tipo de acesso requerido.
Exemplo:
https://auth.olx.com.br/oauth?client_id=1055d3e698d289f2af8663725127bd4b&redirect_uri=https://yourserver.com/token&response_type=code&scope=autoupload%20chat
Lista de Parâmetros:
Parâmetro | Valores | Obrigatório | Descrição |
---|---|---|---|
response_type | code | Sim | Determina que o valor esperado pela requisição será um código de autorização. |
client_id | chave em hash alfanumérico | Sim | Identifica o cliente que está enviando a requisição. O valor do parâmetro tem que ser idêntico ao valor fornecido pelo olx.com.br durante o registro da aplicação. |
redirect_uri | URI | Sim (se integrador cadastrou múltiplas URIs) | URL para onde a resposta da autorização será redirecionada após ter ocorrido a aprovação pelo cliente. |
scope | basic_user_info autoupload chat | Sim | Identifica os acessos que estão sendo requisitados. Para solicitar mais de um scope, separe com espaço. |
state | string | Não | Fornece qualquer valor que pode ser útil a aplicação ao receber a resposta de requisição. |
Resposta
A resposta será enviada para o redirect_uri,conforme especificado na URL da requisição. Se o usuário aprovar o acesso, a resposta conterá um código de autorização e o parâmetro state (se incluído na requisição). Se o usuário não aprovar, a resposta retornará uma mensagem de erro.
Exemplo
https://yourserver.com/token?state=/profile&code=4gP7q7W91aoMsCeLvIaQm6bTrgtp7
Parâmetro | Valores | Obrigatório | Descrição |
---|---|---|---|
code | Código de autorização gerado pelo servidor de autenticação. | Sim | Código de autorização utilizado para solicitar permissão de acesso a recursos de um usuário. Expira 10 minutos após ter sido gerado e não pode ser reutilizado. |
state | Mesmo valor enviado pelo cliente na requisição. | Sim (se presente na requisição) | Fornece qualquer valor que pode ser útil a aplicação ao receber a resposta de requisição. |