Портал разработчиков

Глоссарий

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.