PHPackages                             olxbr/olx-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. olxbr/olx-api-client

ArchivedLibrary[Authentication & Authorization](/categories/authentication)

olxbr/olx-api-client
====================

Client library for Olx API using OAuth2

v0.1.2(10y ago)654.5k↑64.3%22MITPHP

Since Aug 25Pushed 10y agoCompare

[ Source](https://github.com/olxbr/olx-api-client)[ Packagist](https://packagist.org/packages/olxbr/olx-api-client)[ RSS](/packages/olxbr-olx-api-client/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (3)Dependencies (3)Versions (3)Used By (0)

[![Build Status](https://camo.githubusercontent.com/3ac0fd746449086710c31ec32eaea15f2e66900acf4cd29b721500bc2f568166/68747470733a2f2f7472617669732d63692e6f72672f6f6c7862722f6170692d636c69656e742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/olxbr/api-client)[![Coverage Status](https://camo.githubusercontent.com/bce8aebdebd79d8bb1453ceb49ec69b0e3169a2ea11e231a12d422e3660347a6/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6f6c7862722f6170692d636c69656e742f62616467652e7376673f6272616e63683d6d617374657226736572766963653d676974687562)](https://coveralls.io/github/olxbr/olx-api-client?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/11f9c004a259c1e02a4f2f1369e361e08dfbf6e0f6d7a22d3abd8f9f0ef0fd78/68747470733a2f2f706f7365722e707567782e6f72672f6f6c7862722f6f6c782d6170692d636c69656e742f762f737461626c65)](https://packagist.org/packages/olxbr/olx-api-client)[![License](https://camo.githubusercontent.com/5fdd8c232cfb4438ff9f01dfb830a17b3bc5b8ce11cc7f44a6538991c365836c/68747470733a2f2f706f7365722e707567782e6f72672f6f6c7862722f6f6c782d6170692d636c69656e742f6c6963656e7365)](https://packagist.org/packages/olxbr/olx-api-client)

Olx Oauth API
=============

[](#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
--------------

[](#primeiro-passo)

Quer integrar com a OLX? Envie um e-mail para

Criando uma aplicação
---------------------

[](#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
- E-mail
- 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
-----------------------

[](#instalação-via-composer)

```
$ composer require olxbr/olx-api-client

```

Instalação manual
-----------------

[](#instalaçã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
------------------------------

[](#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

[](#olx_oauth_secretsjson)

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.

```
{
	"client_id":"4414d3003b0794ba3dfc8da29493c8497cf352e7",
	"client_secret": "ed63d0a437cd6f9db6299ffe779bca81",
	"scope":"basic_user_info autoupload",
	"redirect_uri":"http://www.suapagina.com.br/return_page.php"
}
```

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

[](#indexphp)

```