Портал за програмисти

Речник

Partner — компанията, която изгражда интеграцията. Partner отговаря за спазване на Общите условия Partner API, за техническото решение и за техническия контакт, свързан с интеграцията.

Application (наричана също Client в API) — софтуер, създаден от Partner, който извиква Partner API за интеграция с OLX. Един Partner може да притежава няколко Applications. Всяка Application има собствени идентификационни данни (client_id / client_secret). Крайните потребители работят с продукта на Partner; Application комуникира с OLX от тяхно име.

User (наричан също продавач или lister) — лице, което използва Application на Partner и има OLX акаунт. Чрез Application User може да публикува обяви, да чете статуси и съобщения и да използва други функции на OLX без директен достъп до сайта или приложението OLX. Когато API действа „от името на потребител“, това е този OLX акаунт — не компанията Partner.

Взаимоотношение:

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

flowchart LR
    Partner["Partner
компания / интегратор"]
    App["Application
(Client в API)"]
    UA["User A
продавач / lister"]
    UB["User B
продавач / lister"]
    UMore["User …
OLX акаунти"]
    Partner -->|притежава| App
    App -->|действа за| UA
    App -->|действа за| UB
    App -->|действа за| UMore

Пример

Partner Excellent and Beautiful Integrations Company (EBIC) създава две Applications:

• Excellent Stock Management
• Excellent Stock Management Premium

Тези Applications помагат на клиентите на EBIC да управляват наличности. Една функция е продажба в OLX.

За клиент на EBIC да продава в OLX, това лице трябва да има OLX акаунт. В термини на API това е User (продавач / lister) — не Client.

User влиза в Excellent Stock Management (или Premium) и разрешава на тази Application достъп до OLX акаунта (OAuth съгласие, инициирано от Application). След съгласието Application може да публикува обяви, да чете статуси, да получава съобщения от купувачи и да използва други функции Partner API от името на този User. Application съхранява токените на този User от своя страна.

В OLX акаунта User вижда свързани Applications и може да прекъсне всяка. След прекъсване тази Application вече не може да използва OLX акаунта. Един User може да свърже Applications от няколко Partners.

Кой се регистрира в Developer Portal?

Partner се регистрира в Developer Portal (трябва да приеме Общите условия Partner API). След това Partner регистрира своите Applications (Clients). Всяка Application получава client_id и client_secret, използвани в OAuth. Partner управлява Applications, настройки и използване на API.

User не се регистрира в Developer Portal. Users използват Application на Partner и я упълномощават за достъп до OLX акаунта. Интегрират се чрез потока за автентикация / съгласие, не чрез портала.

За OAuth, токени и как Application извиква API от името на User, вижте Оторизация в API.

За подробности за заявки, endpoints и scopes, вижте секцията Authentication в API документацията.

За да се регистрирате като Partner и да създадете Application, следвайте Получаване на достъп до API.