Prístup
Autentifikácia
Vyberiete správny typ prístupu pre svoje volanie a nebudete zamieňať partnerský kľúč, JWT a firemný kľúč.
Predpoklady
- Rozhodnuté rozhranie: SAPI, Connector alebo Enterprise API.
IP obmedzenia aktuálneho kľúča
GET /api/v1/auth/ip-allowlist načíta a PUT /api/v1/auth/ip-allowlist nahradí celý zoznam pre autentifikujúci API kľúč, nie pre všetky kľúče firmy. Obe operácie vyžadujú account:read a oprávnenie na Enterprise API podľa plánu/vzťahu.
Telo PUT je {"ip_allowlist":["203.0.113.42"]}; adresu z ukážky nahraďte skutočnou verejnou výstupnou IP. Najviac 50 IPv4/IPv6 adries alebo CIDR rozsahov. Prázdny zoznam ruší IP obmedzenie. Zmena platí pri ďalšom volaní: pred uložením zahrňte aktuálnu aj plánovanú výstupnú IP, inak si môžete zablokovať prístup.
Typy prístupu
| Prístup | Kde sa používa | Čo si strážiť |
|---|---|---|
| Partnerský kľúč (sk_int_*) | Partnerské operácie, pozvánky a onboarding požiadavky. | Identifikuje partnera, nie klientsku firmu. |
| Bearer JWT | Autorizované volanie konkrétneho rozhrania s oprávneniami. | Expirácia a oprávnenia musia pokrývať celé volanie. |
| Firemný kľúč | Práca v mene jednej konkrétnej firmy. | Nikdy nemení firemný kontext na inú firmu. |
| Kľúč viazaný na firmu | Send-only odosielanie za jednu firmu (scopedFirmId). | Nedá sa rozšíriť na inú firmu ani na prijímanie. |
Praktické pravidlá
- Browser session ani interné panelové endpointy nie sú súčasťou verejného API.
- Rozsahy držte na minime: pridajte len to, čo volanie naozaj vyžaduje.
- Jeden kľúč pre viac firiem znamená, že firemný kontext musí byť v každom volaní správny.
Očakávaný výsledok
Volanie používa prístup, ktorý zodpovedá rozhraniu, firme a operácii.
Keď to nefunguje
- 401: chýbajúci, expirovaný alebo nesprávny token.
- 403: správny prístup, ale chýbajúce oprávnenie alebo nepovolená firma.