Skip to main content
Колекцію Postman для Living Security API v1 згенеровано з тієї самої специфікації OpenAPI, на якій базується довідник API v1, тому вона завжди відповідає опублікованому контракту. Вона охоплює всі операції /v1, згруповані за ресурсами, з попередньо налаштованою автентифікацією.

​
Завантаження

Перед тим як надати файл, посилання для завантаження запропонують вам увійти до облікового запису Living Security.

Колекція Living Security API v1

Колекція Postman v2.1 з усіма операціями /v1 та попередньо налаштованою автентифікацією Basic. Колекція baseUrl порожня — перед надсиланням запиту виберіть регіональне середовище.Завантажити колекцію

Виробниче середовище (US)

baseUrl з попередньо встановленим значенням https://api.us-east-1.livingsecurity.ai/v1 та порожніми змінними apiKeySecret і contractVersion, які потрібно заповнити.Завантажити виробниче середовище US

Виробниче середовище (EU)

baseUrl з попередньо встановленим значенням https://api.eu-west-1.livingsecurity.ai/v1 та порожніми змінними apiKeySecret і contractVersion, які потрібно заповнити.Завантажити виробниче середовище EU

Шаблон середовища

Ті самі змінні з порожнім baseUrl для невиробничих конфігурацій.Завантажити шаблон середовища

​
Налаштування в Postman

1

Імпортуйте файли

У Postman виберіть Import і додайте файл колекції та середовище Production (US) або Production (EU), яке відповідає вашій організації. Див. Регіони.
2

Створіть ключ API

У Dashboard відкрийте Settings → Integrations & Developers → Developer Hub, створіть службовий обліковий запис і ключ API. Секрет ключа починається з lsk_live_ і відображається лише один раз — скопіюйте його одразу. Докладніше див. у розділі Ключі API.
3

Вставте секрет

Задайте змінну apiKeySecret — або в імпортованому середовищі (рекомендовано; це змінна типу secret), або на вкладці Variables колекції.
4

Надішліть запит

Виберіть імпортоване регіональне середовище, відкрийте будь-який запит, наприклад Organization → Retrieve the organization, і натисніть Send. Не надсилайте запит, доки не вибрано середовище: змінна колекції baseUrl порожня навмисно.

​
Як попередньо налаштовано автентифікацію

Колекція задає автентифікацію Basic на рівні колекції з іменем користувача apikey і паролем {{apiKeySecret}}. API приймає секрет ключа в будь-якому з полів Basic auth, тому після встановлення змінної це працює без змін. Якщо ви надаєте перевагу автентифікації Bearer, змініть тип Authorization колекції на Bearer Token і використайте {{apiKeySecret}} як токен — API приймає той самий секрет в обох випадках. Використання заголовка Bearer із ключем API не потребує OAuth. Щоб використовувати OAuth, вкажіть у полі Bearer Token токен доступу OAuth замість секрету ключа API. Щоб вибрати метод, див. Автентифікація, а для налаштування токена й клієнта — Облікові дані клієнта OAuth.

​
Заголовок версії контракту

Кожен запит містить заголовок Living-Security-Version зі значенням {{contractVersion}}, який за замовчуванням вимкнено. Залиште його вимкненим, щоб використовувати закріплену версію контракту вашої організації. Увімкніть його, щоб закріпити запит за певною опублікованою версією — опубліковані версії наведено в журналі змін.

​
Параметри запиту та тіла запитів

Фільтри кінцевих точок списків (limit, page_token та фільтри, специфічні для ресурсу) додано до кожного запиту у вимкненому стані, тож після нового імпорту кожна кінцева точка викликається успішно. Увімкніть і заповніть потрібні вам фільтри — про роботу page_token див. Пагінація. Тіла запитів для операцій POST попередньо заповнено типізованими значеннями-заповнювачами.
Колекція повторно генерується з опублікованої специфікації OpenAPI після кожної зміни контракту — завантажуйте свіжу копію, а не редагуйте запити, які потрібно підтримувати актуальними.