Funkcje
API tylko do odczytu i webhooki na zdarzenia
Integracja z własnym systemem jest po to, żeby dane były tam, gdzie ich potrzebujesz. Nie po to, żeby dało się zdalnie wydawać kredyty bez potwierdzenia.
Co da się zrobić przez API
Pobrać listę lokalizacji, listę analiz dla lokalizacji, pojedynczą analizę razem z kartami problemów i cytatami, oraz dane konta. Token ustala jednocześnie tożsamość i organizację, więc nie da się nim sięgnąć po cudze dane nawet przez pomyłkę w adresie.
Tylko odczyt
API nie pozwala uruchamiać analiz. Uruchamianie ich zdalnie oznaczałoby wydawanie kredytów bez potwierdzenia — to wymaga osobnej decyzji, nie doklejenia adresu.
Webhooki na zdarzenia
Gotowa analiza, gotowy raport, alert monitoringu. Wysyłka idzie pod adres, który podasz, z podpisem pozwalającym sprawdzić, że przyszła od nas.
Adresy prywatne odrzucane
Webhook nie pojedzie pod 127.0.0.1 ani pod adres z sieci wewnętrznej. Sprawdzamy to przy zapisie i ponownie przy każdej wysyłce — to jest zabezpieczenie przed odpytywaniem cudzej sieci naszymi rękami.
Krok po kroku
Od tokenu do danych w Twoim systemie
-
1
Generujesz token
W ustawieniach konta, jednym kliknięciem. Token pokazuje się raz — potem widzisz tylko jego początek, bo przechowujemy skrót, nie samą wartość.
-
2
Pobierasz dane
Lista lokalizacji, lista analiz dla lokalizacji, pojedyncza analiza z kartami problemów i cytatami. Wszystko w JSON-ie, z tymi samymi polami, które widzisz w panelu.
-
3
Podpinasz webhook
Podajesz adres, pod który mamy wysyłać zdarzenia: gotowa analiza, gotowy raport, alert monitoringu. Każda wysyłka niesie podpis pozwalający sprawdzić, że przyszła od nas.
-
4
Reagujesz u siebie
Zdarzenie trafia do Twojego systemu, Zapiera albo Make. Stamtąd trafia dalej — do arkusza, do kanału na Slacku albo do zadania w systemie zgłoszeń.
Konkret
Typowa integracja zajmuje godzinę
Najczęstszy scenariusz: webhook wpięty w Make, który po gotowej analizie pobiera kartę problemu o najwyższej wadze i zakłada zadanie w systemie zgłoszeń, z terminem z pola horyzontu i cytatami w opisie. Trzy kroki w kreatorze, bez pisania kodu.
120/min
zapytań na minutę, z uzupełnianiem sześćdziesięciu co minutę. Hojniej niż dla ruchu z przeglądarki i wystarczająco dla każdej sensownej integracji.
Dlaczego tak
Token daje dostęp do danych, nie do budżetu
API jest odczytowe z rozmysłu i to jest jego zaleta w rozmowie z działem IT: token wpuszczony do cudzego skryptu albo do narzędzia niskokodowego nie może wygenerować kosztu. Pobierasz analizy, karty problemów i cytaty do własnego systemu, a decyzja o uruchomieniu kolejnej analizy zostaje tam, gdzie widać jej cenę.
Częste pytania
Jak dostać token API?
Generujesz go w panelu, w ustawieniach konta. Token jest pokazywany raz — potem widzisz tylko jego początek, bo przechowujemy skrót, nie samą wartość.
Jaki jest limit zapytań?
Sto dwadzieścia na minutę, z uzupełnianiem sześćdziesięciu co minutę. To jest hojniej niż dla ruchu z przeglądarki i wystarcza dla każdej sensownej integracji.
Co się dzieje, gdy mój adres webhooka przestanie odpowiadać?
Ponawiamy z rosnącym odstępem, a po serii niepowodzeń webhook jest wyłączany i dostajesz o tym maila. Dziennik prób jest widoczny w panelu przez trzydzieści dni.
Zobacz też
Bądź pierwszy, gdy ruszymy
Zapisz się na listę oczekujących. Napiszemy raz, w dniu startu, z linkiem do założenia konta.