Enterprise referencia

Enterprise firmy

Spravujete firemný kontext v Enterprise API a držíte izoláciu medzi klientskymi firmami.

Predpoklady

  • Enterprise oprávnenie firms:manage.
  • Prehľad, ktoré firmy máte oprávnené obsluhovať a akým režimom.

Firemný kontext volania

  • GET /api/v1/firms vracia firmy, ku ktorým má váš prístup oprávnenie.
  • Pri operáciách v mene konkrétnej firmy použite X-Firm-Id len na endpointoch, ktoré ho podporujú.
  • Nikdy nepoužívajte identifikátor cudzej firmy; izolácia firiem je súčasť kontraktu.

Režimy spolupráce

RežimKto platíČo to znamená pre firmu
Technická delegáciaFirmaVlastná API objednávka a potvrdenie rozsahu.
Spravovaná službaIntegrátorSúhlas firmy zostáva povinný, fakturácia je na integrátorovi.
V zastúpení (represented)Podľa schváleného modelu partneraVyžaduje zákaznícku autorizáciu a samostatnú evidenciu.

Očakávaný výsledok

Každé volanie má správny firemný kontext a vy viete, ktorý režim a platiteľ za firmou stojí.

Keď to nefunguje

  • Firma chýba v zozname: prístup nie je udelený alebo je odvolaný.
  • Volanie v mene firmy vracia 403: chýba X-Firm-Id alebo oprávnenie pre danú firmu.

Pokračujte

  1. Firemný kontext

    Vysvetlí identifikátory, ktoré sa v API často zamieňajú.

  2. Enterprise webhooky

    Referenčný detail Enterprise udalostí a pull režimu.

  3. Odvolanie prístupu

    Presne vymedzí účinok odvolania prístupu.

Súvisiace návody

Všetka dokumentácia