Własne oprogramowanie połączysz z OAKMONT na dwa sposoby. Albo wywołujesz API z użyciem klucza, albo OAKMONT wywołuje Twój endpoint, gdy coś się dzieje na Twoim koncie. Jedno i drugie ustawiasz w zakładce Organizacja.
Tworzenie klucza API#
- Otwórz zakładkę Organizacja i przejdź do rozdziału API dla programistów.
- W części Utwórz klucz wpisz w polu Nazwa, gdzie klucz będzie używany, i naciśnij Utwórz klucz.
- Karta Twój nowy klucz API pokaże pełny klucz. Naciśnij Kopiuj i od razu zapisz go w bezpiecznym miejscu. Pokazujemy go raz i nigdy więcej.
Później na liście widać tylko krótki prefiks każdego klucza oraz to, kiedy został utworzony i kiedy ostatnio go użyto. Konto może mieć do 10 aktywnych kluczy.
Pierwsze wywołanie#
Klucz wysyłasz jako token typu bearer w nagłówku Authorization. Część Twoje pierwsze wywołanie na tej samej stronie podaje gotowe polecenie, które ocenia jedną stronę i zwraca ustalenia w formacie JSON. API obejmuje skanowanie dostępności i wyceny, a przycisk Dokumentacja API otwiera pełny opis.
Tokeny#
Na górze rozdziału są trzy kafelki: Tokeny zużyte w tym miesiącu, Tokeny miesięcznie i Pozostało. Każde wywołanie zmniejsza limit. Gdy tokeny na dany miesiąc się skończą, wywołania są odrzucane do początku kolejnego miesiąca, chyba że dokupisz pakiet tokenów albo przejdziesz na większy plan.
Unieważnianie klucza#
Naciśnij ikonę kosza w wierszu klucza i potwierdź przyciskiem Unieważnij. Wszystko, co korzysta z tego klucza, natychmiast przestaje działać i nie da się tego cofnąć. Unieważnione klucze zostają na liście z odpowiednim oznaczeniem.
Webhooki wychodzące#
W rozdziale Integracje przewiń do sekcji Webhooki wychodzące. W polu Adres endpointu wpisz publiczny adres https i naciśnij Dodaj webhook. Sekret do podpisów dla tego endpointu pojawia się tylko raz. Skopiuj go, zanim naciśniesz Gotowe. Od tej chwili OAKMONT wysyła na ten adres podpisane zdarzenia JSON, na przykład gdy zlecenie zostaje ukończone albo gdy monitorowana strona się pogarsza. Każda wysyłka ma nagłówek X-OAKMONT-Signature, który weryfikujesz sekretem, a nazwa zdarzenia i znacznik czasu są w osobnych nagłówkach.
Sprawdzanie dostarczeń#
Przycisk Wyślij test w wierszu webhooka wysyła zdarzenie testowe i podaje wynik. Oznaczenie obok adresu pokazuje, jak poszła ostatnia wysyłka, razem ze statusem HTTP, który zwrócił Twój serwer. Adresy prywatne i lokalne są odrzucane. Żeby zatrzymać wysyłki na dany endpoint, naciśnij ikonę kosza w jego wierszu i potwierdź przyciskiem Usuń.