Tokeny API i REST API
Proszę utworzyć tokeny API, aby strona, ERP lub inne narzędzia mogły odczytywać i zapisywać kontakty, leady, szanse sprzedaży i firmy przez REST API Dromix.
Kto może z tego korzystać
WłaścicielAdministrator firmyWymagania
Wystarczy rola
Właściciel i Administrator firmy otwierają Administrator firmy → Sprzedaż i integracje → Integracje → API i webhooki. Połącz witrynę, ERP lub inne narzędzia: odczytuj i zapisuj kontakty, leady i szanse sprzedaży przez REST API oraz otrzymuj zdarzenia przesyłane do swoich systemów.
Tworzenie tokenu
- W sekcji Tokeny API proszę wybrać Nowy token.
- Proszę wpisać Nazwa, na przykład system, który będzie go używał.
- W polu Działa jako proszę wybrać, w czyim imieniu są wprowadzane zmiany: - Firma: Zmiany nie wskazują osoby. Działa nadal po odejściu pracowników. - Ja: Zmiany są oznaczane moim nazwiskiem. Przestaje działać po utracie uprawnień administratora.
- W sekcji Uprawnienia proszę zaznaczyć to, czego potrzebuje drugi system, np. Kontakty · odczyt lub Kontakty · zapis. Zapis obejmuje odczyt. Należy przyznać tylko to, czego potrzebuje drugi system.
- Proszę wybrać, kiedy Wygasa, i wybrać Utwórz token.
- Proszę skopiować token i wybrać Zapisałem(-am) go. Token jest wyświetlany tylko ten jeden raz. Należy zapisać go w ustawieniach poufnych drugiego systemu. Przesyłaj go jako:
Authorization: Bearer <token>
Dla każdego systemu warto utworzyć osobny token, aby można je było odbierać oddzielnie.
Korzystanie z API
Proszę wybrać Dokumentacja API, aby zobaczyć endpointy, pola i przykłady. API obejmuje kontakty, leady, szanse sprzedaży i firmy: listowanie, odczyt, tworzenie i zmianę. Nie można nim usuwać rekordów.
- Listy zwracają do 50 pozycji na stronę (maksymalnie 100 z
limit) oraznextCursordla następnej strony. - Każdy token może wysłać 120 żądań na minutę. Powyżej API odpowiada 429 z nagłówkiem
Retry-After. - Każda zmiana wykonana tokenem jest zapisywana w dzienniku audytu z nazwą tokenu.
Odbieranie tokenu
Proszę wybrać Odbierz obok tokenu. Systemy korzystające z tego tokenu natychmiast przestaną działać. Przy każdym tokenie widać, kiedy był ostatnio użyty, więc łatwo znaleźć niepotrzebne.
Aby zdarzenia były wysyłane do Państwa systemów zamiast odpytywania, proszę zobaczyć Webhooki.