Partner, aplikacja i użytkownik — kto jest kim?

Ważne

W dokumentacji Partner API Client oznacza Application (klienta HTTP / OAuth), a nie osobę ani klienta płacącego za produkt. Nie myl Client z User (sprzedawcą / wystawiającym ogłoszenia).

Słowniczek

Partner — firma, która buduje integrację. Partner odpowiada za przestrzeganie regulaminu Partner API, rozwiązanie techniczne oraz kontakt techniczny w sprawie integracji.

Application (w API nazywana też Client) — oprogramowanie stworzone przez Partnera, które wywołuje Partner API w celu integracji z OLX. Jeden Partner może mieć kilka Applications. Każda Application ma własne dane uwierzytelniające (client_id / client_secret). Użytkownicy końcowi korzystają z produktu Partnera; to Application komunikuje się z OLX w ich imieniu.

User (sprzedawca lub wystawiający ogłoszenia) — osoba korzystająca z Application Partnera i posiadająca konto OLX. Przez Application User może publikować ogłoszenia, odczytywać statusy i wiadomości oraz korzystać z innych funkcji OLX bez bezpośredniego używania strony lub aplikacji OLX. Gdy API działa „w imieniu użytkownika”, chodzi o to konto OLX — nie o firmę Partnera.

Relacja:

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

Przykład

Partner Excellent and Beautiful Integrations Company (EBIC) tworzy dwie Applications:

  • Excellent Stock Management
  • Excellent Stock Management Premium

Te Applications pomagają klientom EBIC zarządzać magazynem. Jedną z funkcji jest sprzedaż na OLX.

Aby klient EBIC mógł sprzedawać na OLX, musi mieć konto OLX. W terminologii API jest User (sprzedawca / wystawiający) — a nie Client.

User loguje się do Excellent Stock Management (lub Premium) i udziela tej Application dostępu do swojego konta OLX (zgoda OAuth, rozpoczęta przez Application). Po zgodzie Application może publikować ogłoszenia, odczytywać statusy, odbierać wiadomości kupujących i korzystać z innych funkcji Partner API w imieniu tego Usera. Application przechowuje tokeny tego Usera po swojej stronie.

Na koncie OLX User widzi podłączone Applications i może w każdej chwili odłączyć którąś z nich. Po odłączeniu ta Application nie może już korzystać z jego konta OLX. User może podłączyć Applications od wielu Partnerów.


Kto rejestruje się w Developer Portal?

Partner rejestruje się w Developer Portal (wymagana akceptacja regulaminu Partner API). Następnie Partner rejestruje swoje Applications (Clients). Każda Application otrzymuje client_id i client_secret używane w OAuth. Partner zarządza Applications, ustawieniami i korzystaniem z API.

User nie rejestruje się w Developer Portal. Users korzystają z Application Partnera i autoryzują ją do dostępu do konta OLX. Dołączają przez flow autoryzacji / zgody, a nie przez portal.

Typowe pomyłki

  • Płacący klient produktu Partnera to User (sprzedawca / wystawiający), a nie Client.
  • Client w API zawsze oznacza Application.
  • Nie rejestruj sprzedawców końcowych w Developer Portal jakby byli Partnerami.

OAuth, tokeny i sposób, w jaki Application wywołuje API w imieniu Usera, opisuje artykuł Autoryzacja w API.

Szczegóły żądań, endpointy i scope opisuje sekcja Authentication w dokumentacji API.

Aby zarejestrować się jako Partner i utworzyć Application, postępuj zgodnie z artykułem Dostęp do API.