Портал розробників

Глосарій

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.