Download the PHP package olxbr/olx-api-client without Composer
On this page you can find all versions of the php package olxbr/olx-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download olxbr/olx-api-client
More information about olxbr/olx-api-client
Files in olxbr/olx-api-client
Package olx-api-client
Short Description Client library for Olx API using OAuth2
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package olx-api-client
Olx Oauth API
Este documento descreve como utilizar o protocolo oAuth 2.0 como forma de autenticação na API olx.com.br através de uma aplicação web.
OAuth 2.0 é um protocolo relativamente simples. No início, você registra sua aplicação no olx.com.br, depois a aplicação solicita uma chave de acesso ao servidor de autenticação do olx.com.br e então utiliza essa chave para receber as informações de um recurso da API olx.com.br que deseja acessar.
Primeiro passo
Quer integrar com a OLX? Envie um e-mail para [email protected]
Criando uma aplicação
Antes de iniciar o protocolo de autenticação com o servidor olx.com.br, o cliente deverá registrar sua aplicação, fornecendo os seguintes dados:
- Nome do cliente
- Nome da aplicação
- Descrição da aplicação
- Website
- Telefone
- URIs de redirecionamento (identifica um end-point do cliente que será alvo de redirecionamento no processo de autenticação; mínimo 1 e máximo 3; ver seção 2.1)
Após receber os dados, o olx.com.br entrará em contato com o cliente para fornecer sua identificação client_id e sua chave de segurança, necessários para iniciar a sequência de autorização.
Instalação via composer
$ composer require olxbr/olx-api-clientInstalação manual
Recomendamos fortemente o uso de composer para que você possa sempre ter a versão mais nova de nossa classe sempre que executar o composer update.
Baixe as duas classes que estão em src e faça a include delas em seu projeto manualmente.
Exemplo completo de uso da API
O exemplo que segue irá exibir os dados de um usuário que autorizou a autenticação via oauth e está utilizando o autoload do composer.
Crie um arquivo de configuração em sua aplicação com os dados recebidos pela olx.com.br para uso de nossa api:
olx_oauth_secrets.json
Todas as informações que seguem devem ser específicas para o seu projeto, elas são informadas pela Olx. A redirect_uri deve ser a mesma que você cadastrou em nosso sistema, do contrário não conseguirá utilizar a API.
Insira o código que segue na página onde irá exibir as consultas a api da Olx, neste exemplo utilizamos o index.php na raiz do projeto. Lembre-se de colocar o caminho correto para o arquivo json ao instanciar a classe client.
index.php
Se o usuário conceder a permissão solicitada o servidor de autenticação gera um código de autorização e envia-o para o cliente através dos seguintes parâmetros na URI de redirecionamento:
| Parâmetro | Valores | Descrição |
|---|---|---|
| code (obrigatório) | Código de autorização gerado pelo servidor de autenticação. | 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 (obrigatório se esteve presente na requisição) | Mesmo valor enviado pelo cliente na requisição | Fornece qualquer valor que pode ser útil a aplicação ao receber a resposta de requisição. |
return_page.php
A return_page.php, após receber por GET a variável code, irá concluir a autenticação do usuário por oauth e retornar o token, este token você deve armazenar em sua aplicação associado ao usuário para utilizá-lo sempre que necessitar usar a nossa api.
