API — загальний опис
Призначення API SOM, приклади Postman і послідовність роботи з авторизацією.
Для чого потрібен API
API SOM призначений для обміну даними між SOM та іншими системами, наприклад вашим сайтом або сервісом обробки звернень. Він дозволяє організувати створення заявок програмно.
Підключення виконує розробник інтеграції. Перед початком визначте, які дані потрібно передавати та від імені якого користувача працюватиме інтеграція.
Документація та приклади Postman
Відкрийте колекцію SOM public у Postman. У ній є такі приклади:
| Запит | Що показує |
|---|---|
POST /user/login |
Авторизацію користувача з полями username і password. |
POST /order |
Створення заявки з мінімальним і розширеним набором полів, а також приклад запиту без обов’язкових даних. |
У прикладах створення заявки є дані клієнта, параметри нерухомості, ціна й опис. Використовуйте відповідний приклад як основу для свого сценарію.
Послідовність роботи
- Авторизуйте користувача інтеграції.
- Отримайте токен доступу з відповіді авторизації.
- Передайте токен у заголовку
Authorization: Bearer <token>під час роботи із заявкою. - Надішліть дані та перевірте відповідь: чи створена заявка, чи потрібно виправити заповнення полів.
Запит без обов’язкових даних у колекції допомагає ознайомитися зі сценарієм помилки. Для своїх запитів використовуйте власні дані доступу й значення полів.
Узгодження інтеграції
Якщо потрібної операції немає серед прикладів або ви маєте запитання щодо підключення, зверніться до підтримки SOM і опишіть потрібний обмін даними.