> ## Documentation Index
> Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> Programově dotazujte a upravujte svá CRM data pomocí REST nebo GraphQL.

export const VimeoEmbed = ({videoId, title = 'Video'}) => <div style={{
  padding: '69.01% 0 0 0',
  position: 'relative',
  margin: '32px 0px',
  borderRadius: '16px',
  overflow: 'hidden',
  border: '2px solid black'
}}>
    <iframe src={`https://player.vimeo.com/video/${videoId}?autoplay=1&loop=1&autopause=0&background=1&app_id=58479`} frameBorder="0" allow="autoplay; fullscreen; picture-in-picture; clipboard-write" style={{
  position: 'absolute',
  top: 0,
  left: 0,
  width: '100%',
  height: '100%',
  transform: 'scale(1.1)'
}} title={title} />
  </div>;

Twenty bylo vytvořeno s ohledem na vývojáře, nabízíme výkonné API, které se přizpůsobí vašemu vlastnímu datovému modelu. Nabízíme čtyři typy API, které splňují různé potřeby integrace.

## Přístup orientovaný na vývojáře

Twenty generuje API specificky pro váš datový model:

* **Nejsou vyžadována dlouhá ID**: Používejte v koncových bodech přímo názvy objektů a polí.
* **Standardní a vlastní objekty jsou rovnocenně zpracovány**: Vaše vlastní objekty mají stejnou podporu API jako vestavěné.
* **Vyhrazené koncové body**: Každý objekt a pole má svůj vlastní koncový bod API.
* **Vlastní dokumentace**: Generována specificky pro datový model vašeho pracovního prostoru.

<Note>
  Vaše personalizovaná dokumentace k API je dostupná v **Nastavení → API & Webhooks** po vytvoření API klíče. Protože Twenty generuje API odpovídající vašemu vlastnímu datovému modelu, dokumentace je jedinečná pro váš pracovní prostor.
</Note>

## Dva typy API

### Core API

Přístupné na `/rest/` nebo `/graphql/`

Pracujte se svými skutečnými **záznamy** (daty):

* Vytvářejte, čtěte, aktualizujte a mazejte Lidi, Společnosti, Příležitosti atd.
* Dotazujte a filtrujte data
* Spravování vztahů mezi záznamy.

### Metadata API

Přístupné na `/rest/metadata/` nebo `/metadata/`

Spravujte svůj **pracovní prostor a datový model**:

* Vytvářet, upravovat nebo mazat objekty a pole.
* Konfigurace nastavení pracovního prostoru.
* Definujte vztahy mezi objekty

## REST vs GraphQL

Jak Core, tak Metadata API jsou k dispozici ve formátech REST a GraphQL:

| Formát      | Dostupné operace                                                       |
| ----------- | ---------------------------------------------------------------------- |
| **REST**    | CRUD, hromadné operace, operace upsert                                 |
| **GraphQL** | Stejné + **hromadné operace upsert**, dotazy na vztahy v jednom volání |

Zvolte podle svých potřeb — oba formáty přistupují ke stejným datům.

## Koncové body API

| Prostředí           | Základní URL              |
| ------------------- | ------------------------- |
| **Cloud**           | `https://api.twenty.com/` |
| **Vlastní hosting** | `https://{your-domain}/`  |

## Ověření

Každý požadavek na API vyžaduje klíč API v hlavičce:

```
Authorization: Bearer YOUR_API_KEY
```

### Vytvořit API klíč

1. Přejděte na **Nastavení → APIs & Webhooks**
2. Klikněte na **+ Vytvořit klíč**
3. Nakonfigurujte:
   * **Název**: Popisný název pro klíč
   * **Datum vypršení platnosti**: Kdy klíč vyprší
4. Klikněte na **Uložit**
5. **Zkopírujte ihned** — klíč se zobrazí pouze jednou

<VimeoEmbed videoId="928786722" title="Vytvoření klíče API" />

<Warning>
  Váš klíč API poskytuje přístup k citlivým datům. Nesdílejte ho s nedůvěryhodnými službami. Pokud je kompromitován, okamžitě ho deaktivujte a vygenerujte nový.
</Warning>

### Přiřaďte roli klíči API

Pro vyšší bezpečnost přiřaďte konkrétní roli, abyste omezili přístup:

1. Přejděte na **Nastavení → Členové → Role**
2. Klikněte na roli, kterou chcete přiřadit
3. Otevřete záložku **Přiřazení**
4. V části **API Keys** klikněte na **+ Přiřadit ke klíči API**
5. Vyberte klíč API

Klíč zdědí oprávnění této role. Podrobnosti viz [Oprávnění](/l/cs/user-guide/permissions-access/capabilities/permissions).

### Spravovat API klíče

**Znovu vygenerovat**: Nastavení → APIs & Webhooks → Klikněte na klíč → **Znovu vygenerovat**

**Smazat**: Nastavení → APIs & Webhooks → Klikněte na klíč → **Smazat**

## API Playground

Testujte svá API přímo v prohlížeči pomocí našeho vestavěného playgroundu — k dispozici pro **REST** i **GraphQL**.

### Přístup do Playgroundu

1. Přejděte na **Nastavení → APIs & Webhooks**
2. Vytvořte klíč API (povinné)
3. Klikněte na **REST API** nebo **GraphQL API** pro otevření playgroundu

### Co získáte

* **Interaktivní dokumentace**: Generována pro váš specifický datový model
* **Živé testování**: Spouštějte reálná volání API vůči vašemu pracovnímu prostoru
* **Průzkumník schématu**: Procházejte dostupné objekty, pole a vztahy
* **Tvůrce požadavků**: Sestavujte dotazy s automatickým doplňováním

Playground odráží vaše vlastní objekty a pole, takže dokumentace je pro váš pracovní prostor vždy přesná.

## Hromadné operace

REST i GraphQL podporují hromadné operace:

* **Velikost dávky**: Až 60 záznamů na požadavek.
* **Operace**: Vytváření, aktualizace a mazání více záznamů

**Funkce pouze pro GraphQL:**

* **Hromadný upsert**: Vytvoření nebo aktualizace v jednom volání
* Používejte množná čísla názvů objektů (např. `CreateCompanies` místo `CreateCompany`)

## Limity rychlosti

Požadavky na API jsou omezovány, aby byla zajištěna stabilita platformy:

| Limit              | Hodnota              |
| ------------------ | -------------------- |
| **Požadavky**      | 100 volání za minutu |
| **Velikost dávky** | 60 záznamů na volání |

<Tip>
  Pro maximalizaci propustnosti používejte hromadné operace — zpracujte až 60 záznamů v jediném volání API místo odesílání jednotlivých požadavků.
</Tip>