github-actions[bot]
2de681da72
Created by Github action <!-- This is an auto-generated description by cubic. --> <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22317?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. --> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
2.5 KiB
Plaintext
56 lines
2.5 KiB
Plaintext
---
|
||
title: API
|
||
icon: plug
|
||
description: REST a GraphQL API generovaná z vašeho schématu pracovního prostoru.
|
||
---
|
||
|
||
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
||
|
||
## 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
|
||
|
||
| Prostředí | Základní URL |
|
||
| -------------------- | ------------------------- |
|
||
| Cloud | `https://api.twenty.com/` |
|
||
| Samostatně hostované | `https://{your-domain}/` |
|
||
|
||
## Ověření
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
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.
|
||
|
||
<VimeoEmbed videoId="928786722" title="Vytvoření klíče API" />
|
||
|
||
Pro přístup založený na OAuthu (externí aplikace jednající jménem uživatelů), viz [OAuth](/l/cs/developers/extend/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í
|
||
|
||
| Limit | Hodnota |
|
||
| -------------- | -------------------- |
|
||
| Požadavky | 100 za minutu |
|
||
| Velikost šarže | 60 záznamů na volání |
|