Dokumentacja API

Jak zacząć

• Należy utworzyć aplikację - zobacz Konfiguracja aplikacji.
• Pamiętaj, aby zapisać klucz do API

Autoryzacja żądań do API

Zapytania do API można autoryzować na dwa sposoby:

• Przez dodanie nagłówka Authorization o wartości klucza aplikacji.
• Przez dodanie parametru app_key z wartością klucza aplikacji bezpośrednio w URL (query_string): {API}?app_key=997885:be022854-d6e8-4366-8f88-b1712deeb70d-6c1bd95b-14d4-4de5-80db-25ad890cf820

Wykorzystanie przykładów

Aby korzystać z zamieszczonych w dokumentacji przykładów należy ustawić zmienne środowiskowe. Ustaw zmienną środowiskową CONPEEK_URL na adres serwera API oraz CONPEEK_KEY jako klucz aplikacji.

Linux

export CONPEEK_URL="[URL]"

export CONPEEK_KEY="[KEY]"

Windows

PowerShell:

$env:CONPEEK_URL="[URL]"

$env:CONPEEK_KEY="[KEY]"

Command:

set CONPEEK_URL=[URL]

set CONPEEK_KEY=[KEY]

Słownik

{API} - adres url do serwera API

{KEY} - klucz do aplikacji