Partner, aplicação e utilizador — quem é quem?

Importante

Na documentação Partner API, Client significa a Application (cliente HTTP / OAuth), não uma pessoa nem o cliente que paga por um produto. Não confunda Client com User (vendedor ou lister).

Glossário

Partner — a empresa que constrói a integração. O Partner é responsável por cumprir os Termos e condições Partner API, pela solução técnica e pelo contacto técnico relacionado com a integração.

Application (também designada Client na API) — software criado pelo Partner que chama a Partner API para integrar com a OLX. Um Partner pode ter várias Applications. Cada Application tem as suas credenciais (client_id / client_secret). Os utilizadores finais trabalham com o produto do Partner; a Application é o que comunica com a OLX em seu nome.

User (também designado vendedor ou lister) — pessoa que usa a Application do Partner e tem uma conta OLX. Através da Application, o User pode publicar anúncios, ler estados e mensagens e usar outras funcionalidades OLX sem aceder diretamente ao site ou app OLX. Quando a API age «em nome de um utilizador», significa esta conta OLX — não a empresa Partner.

Relação:

Partner → owns Application(s) / Client(s) → each Application acts on behalf of User(s) (sellers / listers)

Exemplo

O Partner Excellent and Beautiful Integrations Company (EBIC) cria duas Applications:

  • Excellent Stock Management
  • Excellent Stock Management Premium

Estas Applications ajudam os clientes da EBIC a gerir inventário. Uma funcionalidade é vender na OLX.

Para um cliente EBIC vender na OLX, essa pessoa precisa de uma conta OLX. Em termos de API é um User (vendedor / lister) — não um Client.

O User inicia sessão no Excellent Stock Management (ou Premium) e autoriza essa Application a aceder à conta OLX (consentimento OAuth, iniciado pela Application). Após o consentimento, a Application pode publicar anúncios, ler estados, receber mensagens de compradores e usar outras funcionalidades Partner API em nome desse User. A Application guarda os tokens desse User do seu lado.

Na conta OLX, o User vê Applications ligadas e pode desligar qualquer uma. Após desligar, essa Application deixa de poder usar a conta OLX. Um User pode ligar Applications de vários Partners.


Quem se regista no Developer Portal?

O Partner regista-se no Developer Portal (deve aceitar os Termos e condições Partner API). Depois o Partner regista as suas Applications (Clients). Cada Application recebe client_id e client_secret usados no OAuth. O Partner gere Applications, definições e utilização da API.

O User não se regista no Developer Portal. Os Users usam a Application do Partner e autorizam-na a aceder à conta OLX. Integram-se pelo fluxo de autenticação / consentimento, não pelo portal.

Confusões frequentes a evitar

  • O cliente pagador do produto do Partner é o User (vendedor / lister), não o Client.
  • Client na API significa sempre Application.
  • Não registe vendedores finais no Developer Portal como se fossem Partners.

Para OAuth, tokens e como a Application chama a API em nome de um User, consulte Autorização na API.

Para detalhes sobre pedidos, endpoints e scopes, consulte a secção Authentication na documentação da API.

Para se registar como Partner e criar uma Application, siga Obter acesso à API.