8cadd00d34
Created by Github action --------- Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
4.0 KiB
Plaintext
56 lines
4.0 KiB
Plaintext
---
|
||
title: API
|
||
image: '"/images/docs/getting-started/api.png"'
|
||
info: '"Fedezze fel, hogyan használhatja az API-jainkat."'
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Áttekintés
|
||
|
||
A Twenty API lehetővé teszi a fejlesztők számára, hogy programozottan lépjenek kapcsolatba a Twenty CRM platformmal. Az API használatával integrálhatja a Twenty-t más rendszerekkel, automatizálhatja az adatszinkronizációt és egyedi megoldásokat építhet ügyféladataival kapcsolatban. Az API végpontokat biztosít a **CRM-objektumok (például emberek és cégek) létrehozására, olvasására, frissítésére és törlésére**, valamint a metaadat-konfiguráció elérésére.
|
||
|
||
**API Játékterem:** Mostantól hozzáférhet az API Játékteremhez az alkalmazás beállításain belül. Valós időben kipróbálhatja az API-hívásokat, ha bejelentkezik a Twenty munkaterületére, és elnavigál a **Beállítások → API-k & Webhookok** menüpontba. Ez megnyitja az alkalmazásbeli API Játéktermet és az API kulcsok beállításait.
|
||
**[Menjen az API Beállításokhoz](https://app.twenty.com/settings)**
|
||
|
||
## Hitelesítés
|
||
|
||
A Twenty API kulcsokat használ hitelesítéshez. Minden védett végpont kéréséhez mellékelni kell egy API kulcsot a fejlécben.
|
||
|
||
- **API Kulcsok:** Új API kulcsot generálhat a Twenty alkalmazás **API beállítások** oldalán. Minden API kulcs egy titkos token, amely hozzáférést biztosít a CRM adataihoz, ezért tartsa biztonságban. Ha egy kulcs veszélybe kerül, vonja vissza a beállításokból, és generáljon újat.
|
||
- **Hitelesítési Fejléc:** Miután megszerez egy API kulcsot, tegye bele a `Authorization` fejlécbe a HTTP kérések során. Használja a Bearer token sémát. Például:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
Cserélje le a `YOUR_API_KEY` értéket az Ön által megszerzett kulcsra. Minden **API kéréshez** jelen kell lennie ennek a fejlécnek. Ha a token hiányzik vagy érvénytelen, az API hitelesítési hibával válaszol (HTTP 401 Hozzáférés megtagadva).
|
||
|
||
## API Végpontok
|
||
|
||
Minden erőforrás elérhető és elérhető REST vagy GraphQL útján.
|
||
|
||
- **Felhő:** `https://api.twenty.com/` vagy az Ön egyedi domainje / aldomainje
|
||
- **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/`).
|
||
|
||
A végpontok két kategóriába sorolhatók: **Core API** és **Metadata API**. A **Core API** a fő CRM adatokkal (pl. emberek, cégek, jegyzetek, feladatok), míg a **Metadata API** a konfigurációs adatokkal foglalkozik (mint például egyedi mezők vagy objektum definíciók). A legtöbb integráció elsősorban a Core API-t fogja használni.
|
||
|
||
### Core API
|
||
|
||
Elérhető a `/rest/` vagy `/graphql/` útján.
|
||
A **Core API** egységes interfészként szolgál a fő CRM entitások (emberek, cégek, jegyzetek, feladatok) és azok kapcsolatai kezeléséhez, kínálva **mind REST, mind GraphQL** interakciós modelleket.
|
||
|
||
### Metadata API
|
||
|
||
Elérhető a `/rest/metadata/` vagy `/metadata/` útján.
|
||
A Metadata API végpontjai lehetővé teszik, hogy hozzáférjen a sémával és beállításokkal kapcsolatos információkhoz. Például lekérdezheti az egyedi mezők definícióit, objektum sémákat stb.
|
||
|
||
- **Példa Végpontok:**
|
||
|
||
- `GET /rest/metadata/objects` – Listázza az összes objektumtípust és azok metaadatait (mezők, kapcsolatok).
|
||
- `GET /rest/metadata/objects/{objectName}` – Lekérdezheti egy adott objektum metaadatait (pl.: `people`, `companies`).
|
||
- `GET /rest/metadata/picklists` – Lekérdezheti a CRM-ben meghatározott picklist (legördülő lista) mező opcióit.
|
||
|
||
A metaadat végpontokat jellemzően arra használják, hogy megértsék az adatok struktúráját (a dinamikus integrációkhoz vagy űrlap építéshez), nem pedig a tényleges rekordok kezeléséhez. A legtöbb esetben ezek csak olvasásra szolgálnak. Hitelesítés szükséges ezekhez is (használja az API kulcsát). |