/v1 operācijas,
sagrupētas pēc resursiem, ar iepriekš konfigurētu autentifikāciju.
Lejupielāde
Lejupielādes saites pirms faila nodrošināšanas aicinās jūs pierakstīties
ar savu Living Security kontu.
Living Security API v1 kolekcija
Postman Collection v2.1 ar visām
/v1 operācijām un iepriekš
konfigurētu Basic autentifikāciju. Kolekcijas baseUrl ir tukšs — pirms pieprasījuma
nosūtīšanas atlasiet reģionālo vidi.Lejupielādēt kolekcijuProdukcijas (US) vide
baseUrl iepriekš iestatīts uz https://api.us-east-1.livingsecurity.ai/v1, ar
tukšiem mainīgajiem apiKeySecret un contractVersion, kas jāaizpilda.Lejupielādēt ASV produkcijas vidiProdukcijas (EU) vide
baseUrl iepriekš iestatīts uz https://api.eu-west-1.livingsecurity.ai/v1, ar
tukšiem mainīgajiem apiKeySecret un contractVersion, kas jāaizpilda.Lejupielādēt ES produkcijas vidiVides veidne
Tie paši mainīgie ar tukšu
baseUrl, neprodukcijas iestatījumiem.Lejupielādēt vides veidniIestatīšana programmā Postman
1
Importējiet failus
Programmā Postman izvēlieties Import un ievelciet kolekcijas failu kopā
ar Production (US) vai Production (EU) vidi, kas atbilst jūsu
organizācijai. Skatiet Reģioni.
2
Izveidojiet API atslēgu
Sadaļā Dashboard atveriet Settings → Integrations & Developers →
Developer Hub, izveidojiet servisa kontu un izveidojiet API atslēgu. Atslēgas noslēpums sākas ar
lsk_live_ un
tiek parādīts tikai vienreiz — nekavējoties to nokopējiet. Plašāku informāciju skatiet sadaļā
API atslēgas.3
Ielīmējiet noslēpumu
Iestatiet mainīgo
apiKeySecret — vaiu importētajā vidē
(ieteicams; tas ir slepenā tipa mainīgais), vai kolekcijas
cilnē Variables.4
Nosūtiet pieprasījumu
Atlasiet importēto reģionālo vidi, atveriet jebkuru pieprasījumu — piemēram,
Organization → Retrieve the organization — un noklikšķiniet uz Send. Nesūtiet,
kamēr nav atlasīta vide; kolekcijas
baseUrl ir tukšs
apzināti.Kā iepriekš konfigurēta autentifikācija
Kolekcija iestata Basic autentifikāciju kolekcijas līmenī ar lietotājvārduapikey
un paroli {{apiKeySecret}}. API pieņem atslēgas noslēpumu jebkurā
Basic autentifikācijas laukā, tāpēc tas darbojas bez izmaiņām, tiklīdz ir iestatīts mainīgais.
Ja vēlaties izmantot Bearer autentifikāciju, mainiet kolekcijas Authorization
tipu uz Bearer Token un kā tokenu izmantojiet {{apiKeySecret}} — API
abos gadījumos pieņem to pašu noslēpumu.
Bearer galvenes izmantošanai ar API atslēgu OAuth nav nepieciešams. Lai izmantotu OAuth,
iestatiet Bearer Token kā savu OAuth piekļuves tokenu, nevis API atslēgas noslēpumu.
Skatiet Autentifikācija, lai izvēlētos metodi, un
OAuth client credentials tokena un klienta iestatīšanai.
Līguma versijas galvene
Katrs pieprasījums saturLiving-Security-Version galveni, kas iepriekš iestatīta uz
{{contractVersion}} un pēc noklusējuma ir atspējota. Atstājiet to atspējotu, lai izmantotu savas
organizācijas piesaistīto līguma versiju. Iespējojiet to, lai piesaistītu pieprasījumu
konkrētai publicētai versijai — publicētās versijas skatiet izmaiņu žurnālā.
Vaicājuma parametri un pamattekstu saturs
Saraksta galapunktu filtri (limit, page_token un resursam specifiskie filtri)
ir iekļauti katrā pieprasījumā, bet atspējoti, tāpēc jauns imports veiksmīgi izsauc katru
galapunktu. Iespējojiet un aizpildiet nepieciešamos — kā darbojas page_token, skatiet sadaļā
Lappušošana. Pieprasījumu
pamatteksti POST operācijām ir iepriekš aizpildīti ar tipizētām vietturu vērtībām.
Kolekcija tiek ģenerēta no jauna no publicētās OpenAPI specifikācijas pēc katras
līguma izmaiņas — lejupielādējiet jaunu kopiju, nevis rediģējiet pieprasījumus,
kurus vēlaties uzturēt aktuālus.

