Skip to main content

API schéma pro jednotlivé nájemce

Pro dvacet není žádný statický API odkaz. Každý pracovní prostor má své vlastní schéma — když přidáte vlastní objekt (řekněme Invoice), okamžitě získá REST a GraphQL koncové body shodné s vestavěnými objekty, jako je Company nebo Person. API je generováno z schématu, takže koncové body používají vaše názvy objektů a polí přímo – žádné neprůhledné ID. Dokumentace API specifická pro pracovní prostor je dostupná v Nastavení → API a Webhooks po vytvoření API klíče. Obsahuje interaktivní hřiště, kde můžete uskutečňovat skutečné hovory proti svým datům.

Dvě API

Jádro API/rest/ a /graphql/ CRUD v záznamech: Lidé, Společnosti, příležitosti, vaše vlastní objekty. Dotazy, filtry, pohybové vztahy. Metadata API/rest/metadata/ a /metadata/ Správa schémat: vytvořit/upravit/odstranit objekty, pole a vztahy. Takto programově změníte svůj datový model. Obojí je k dispozici jako REST a GraphQL. GraphQL přidává dávky a schopnost procházet vztahy v jediném dotazu. V každém případě stejné podkladové údaje.

Základní URL adresy

Ověření

Vytvořte API klíč v Nastavení → API & Webhooks → + Vytvořit klíč. Zkopírujte ji okamžitě - je to zobrazeno jednou. API klíče lze omezit na konkrétní roli v Settings → Members → Roles → Assignment tab, aby se omezilo, k čemu mají přístup. Pro přístup založený na OAuthu (externí aplikace jednající jménem uživatelů), viz OAuth.

Provoz šarže

Podpora REST i GraphQL dávkování až 60 záznamů pro každou žádost – vytvořit, aktualizovat nebo smazat. GraphQL také podporuje dávkový náhled (create-or-update v jednom hovoru) pomocí plurálu jako je CreateCompanies.

Míra omezení