---
title: API
image: /images/docs/getting-started/api.png
info: Objevte, jak používat naše API.
---

<Frame>
  <img src="/images/docs/getting-started/api.png" alt="Header" />
</Frame>

## Přehled

API Twenty umožňuje vývojářům programově pracovat s platformou Twenty CRM. Pomocí API můžete integrovat Twenty s dalšími systémy, automatizovat synchronizaci dat a budovat vlastní řešení okolo vašich zákaznických dat. API poskytuje koncové body pro **vytváření, čtení, aktualizaci a mazání** základních CRM objektů (jako jsou osoby a společnosti) a také přístup k metadatové konfiguraci.

**API Playground:**  You can now access the API Playground within the app's settings. Chcete-li vyzkoušet volání API v reálném čase, přihlaste se do svého pracovního prostoru Twenty a přejděte do **Nastavení → API a Webhooky**. This opens the in-app API Playground and the settings for API keys.
**[Přejít na nastavení API](https://app.twenty.com/settings)**

## Ověření

API Twenty používá klíče API pro autentizaci. Každý požadavek na chráněné koncové body musí zahrnovat klíč API v záhlaví.

- **Klíče API:** Můžete vygenerovat nový klíč API na stránce **nastavení API** ve vaší aplikaci Twenty. Každý klíč API je tajný token, který poskytuje přístup k vašim CRM datům, takže jej uchovávejte v bezpečí. Pokud je klíč ohrožen, zrušte ho v nastaveních a vygenerujte nový.
- **Auth Header:** Once you have an API key, include it in the `Authorization` header of your HTTP requests. Použijte schéma Bearer token. Například:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```

  Nahraďte `YOUR_API_KEY` klíčem, který jste získali. Toto záhlaví musí být přítomno u **všech API požadavků**. Pokud token chybí nebo je neplatný, API odpoví chybou autentizace (HTTP 401 Neautorizováno).

## Koncové body API

Všechny zdroje lze přistupovat přes REST nebo GraphQL.

- **Cloud:** `https://api.twenty.com/` nebo vaše vlastní doména / subdoména
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).

Koncové body jsou rozděleny do dvou kategorií: **Core API** a **Metadata API**. **Core API** se zabývá primárními daty CRM (např. lidé, společnosti, poznámky, úkoly), zatímco **Metadata API** pokrývá konfigurační data (jako vlastní pole nebo definice objektů). Většina integrací bude primárně využívat Core API.

### Core API

Přístupné na `/rest/` nebo `/graphql/`.
**Core API** slouží jako sjednocené rozhraní pro správu základních CRM entit (osoby, společnosti, poznámky, úkoly) a jejich vztahů, poskytuje **jak REST, tak GraphQL** modely interakce.

### Metadata API

Přístupné na `/rest/metadata/` nebo `/metadata/`.
Koncové body Metadata API umožňují získat informace o vašem schématu a nastaveních. Například můžete získat definice vlastních polí, schémata objektů, atd.

- **Příklad Koncových Bodů:**

  - `GET /rest/metadata/objects` – Seznam všech typů objektů a jejich metadat (pole, vztahy).
  - `GET /rest/metadata/objects/{objectName}` – Získat metadata pro konkrétní objekt (např. `people`, `companies`).
  - `GET /rest/metadata/picklists` – Získat možnosti rozevíracího seznamu (picklistu) definované v CRM.

Typicky jsou metadata koncové body používány k porozumění struktuře dat (pro dynamické integrace nebo tvorbu formulářů) spíše než ke správě skutečných záznamů. Ve většině případů jsou pouze pro čtení. Autentizace je také vyžadována (použijte váš klíč API).