Skip to main content
Kolekcja Postman dla interfejsu Living Security API v1 jest generowana z tej samej specyfikacji OpenAPI, na której opiera się dokumentacja referencyjna API v1, dzięki czemu zawsze odpowiada opublikowanemu kontraktowi. Obejmuje wszystkie operacje /v1, pogrupowane według zasobów, z wstępnie skonfigurowanym uwierzytelnianiem.

​
Pobieranie

Linki do pobrania wyświetlą monit o zalogowanie się na konto Living Security, zanim plik zostanie udostępniony.

Kolekcja Living Security API v1

Kolekcja Postman w wersji 2.1 ze wszystkimi operacjami /v1 i wstępnie skonfigurowanym uwierzytelnianiem Basic. Zmienna kolekcji baseUrl jest pusta — przed wysłaniem żądania wybierz środowisko regionalne.Pobierz kolekcję

Środowisko produkcyjne (US)

baseUrl z wartością wstępnie ustawioną na https://api.us-east-1.livingsecurity.ai/v1 oraz pustymi zmiennymi apiKeySecret i contractVersion do uzupełnienia.Pobierz środowisko produkcyjne US

Środowisko produkcyjne (EU)

baseUrl z wartością wstępnie ustawioną na https://api.eu-west-1.livingsecurity.ai/v1 oraz pustymi zmiennymi apiKeySecret i contractVersion do uzupełnienia.Pobierz środowisko produkcyjne EU

Szablon środowiska

Te same zmienne z pustą wartością baseUrl, do konfiguracji nieprodukcyjnych.Pobierz szablon środowiska

​
Konfiguracja w programie Postman

1

Zaimportuj pliki

W programie Postman wybierz Importuj i przeciągnij plik kolekcji oraz środowisko Production (US) lub Production (EU) odpowiadające organizacji. Zobacz Regiony.
2

Utwórz klucz API

W Pulpicie otwórz Ustawienia → Integracje i Developer Hub → Developer Hub, utwórz konto usługi, a następnie klucz API. Sekret klucza zaczyna się od lsk_live_ i jest wyświetlany tylko raz — skopiuj go od razu. Szczegółowe informacje znajdziesz w sekcji Klucze API.
3

Wklej sekret

Ustaw zmienną apiKeySecret — w zaimportowanym środowisku (zalecane; jest to zmienna typu secret) lub na karcie Zmienne kolekcji.
4

Wyślij żądanie

Wybierz zaimportowane środowisko regionalne, otwórz dowolne żądanie — na przykład Organizacja → Retrieve the organization — i kliknij Wyślij. Nie wysyłaj żądań, dopóki nie zostanie wybrane środowisko; zmienna kolekcji baseUrl jest celowo pusta.

​
Jak wstępnie skonfigurowano uwierzytelnianie

Kolekcja ustawia uwierzytelnianie Basic na poziomie kolekcji z nazwą użytkownika apikey i hasłem {{apiKeySecret}}. Interfejs API akceptuje sekret klucza w obu polach uwierzytelniania Basic, więc po ustawieniu zmiennej rozwiązanie działa bez zmian. Jeśli wolisz uwierzytelnianie typu bearer, zmień typ Authorization kolekcji na Bearer Token i użyj {{apiKeySecret}} jako tokenu — interfejs API akceptuje ten sam sekret w obu przypadkach. Użycie nagłówka Bearer z kluczem API nie wymaga protokołu OAuth. Aby użyć OAuth, ustaw w polu Bearer Token token dostępu OAuth zamiast sekretu klucza API. Zobacz Uwierzytelnianie, aby wybrać metodę, oraz OAuth client credentials, aby skonfigurować token i klienta.

​
Nagłówek wersji kontraktu

Każde żądanie zawiera nagłówek Living-Security-Version z wartością wstępnie ustawioną na {{contractVersion}}, domyślnie wyłączony. Pozostaw go wyłączonego, aby użyć przypiętej wersji kontraktu Twojej organizacji. Włącz go, aby przypiąć żądanie do konkretnej opublikowanej wersji — opublikowane wersje znajdziesz w dzienniku zmian.

​
Parametry zapytania i treści żądań

Filtry punktów końcowych list (limit, page_token oraz filtry specyficzne dla zasobu) są dołączone do każdego żądania, ale wyłączone, dzięki czemu świeżo zaimportowana kolekcja poprawnie wywołuje każdy punkt końcowy. Włącz i uzupełnij te, których potrzebujesz — zobacz Paginacja, aby dowiedzieć się, jak działa page_token. Treści żądań operacji POST są wstępnie wypełnione typowanymi wartościami zastępczymi.
Kolekcja jest generowana ponownie z opublikowanej specyfikacji OpenAPI przy każdej zmianie kontraktu — pobierz nową kopię zamiast edytować żądania, które mają pozostać aktualne.