/v1,
сгруппированные по ресурсам, с предварительно настроенной аутентификацией.
Загрузка
Перед выдачей файла по ссылкам для загрузки вам будет предложено войти
в учетную запись Living Security.
Коллекция Living Security API v1
Postman Collection v2.1 со всеми операциями
/v1 и предварительно настроенной
аутентификацией Basic. Значение baseUrl в коллекции пустое — выберите региональное
окружение, прежде чем отправлять запрос.Скачать коллекциюОкружение Production (US)
baseUrl со значением https://api.us-east-1.livingsecurity.ai/v1 по умолчанию и
пустыми переменными apiKeySecret и contractVersion, которые необходимо заполнить.Скачать производственное окружение для USОкружение Production (EU)
baseUrl со значением https://api.eu-west-1.livingsecurity.ai/v1 по умолчанию и
пустыми переменными apiKeySecret и contractVersion, которые необходимо заполнить.Скачать производственное окружение для EUШаблон окружения
Те же переменные с пустым значением
baseUrl для непроизводственных конфигураций.Скачать шаблон окруженияНастройка в Postman
1
Импортируйте файлы
В Postman выберите Импорт и добавьте файл коллекции, а также окружение
Production (US) или Production (EU), соответствующее
организации. См. Регионы.
2
Создайте ключ API
На Панели управления откройте Настройки → Integrations & Developers →
Developer Hub, создайте служебную учетную запись и ключ API. Секрет ключа начинается с
lsk_live_ и
отображается только один раз — скопируйте его сразу. Подробнее см.
в разделе Ключи API.3
Вставьте секрет
Задайте переменную
apiKeySecret — либо в импортированном окружении
(рекомендуется; это переменная типа secret), либо на вкладке
Переменные коллекции.4
Отправьте запрос
Выберите импортированное региональное окружение, откройте любой запрос — например,
Организация → Retrieve the organization — и нажмите Отправить. Не
отправляйте запросы, пока не выбрано окружение: значение
baseUrl в коллекции намеренно
пустое.Как предварительно настроена аутентификация
В коллекции на уровне коллекции задана аутентификация Basic с именем пользователяapikey
и паролем {{apiKeySecret}}. API принимает секрет ключа в любом из полей
Basic-аутентификации, поэтому после задания переменной все работает без дополнительной настройки.
Если вы предпочитаете аутентификацию типа 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 при каждом
изменении контракта — скачивайте свежую копию, а не редактируйте запросы, которые
нужно поддерживать в актуальном состоянии.