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
5.6 KiB
Plaintext
56 lines
5.6 KiB
Plaintext
---
|
||
title: АПИ
|
||
image: /images/docs/getting-started/api.png
|
||
info: Discover how to use our APIs.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Преглед
|
||
|
||
Twenty API омогућава програмерима да кроз програме комуницирају са платформом Twenty CRM. Коришћењем API-ја, можете интегрисати Twenty са другим системима, аутоматизовати синхронизацију података и градити прилагођена решења око података о вашим купцима. API пружа крајње тачке за **креирање, читање, ажурирање и брисање** основних CRM објеката (као што су особе и компаније), као и приступ подешавањима метаподатака.
|
||
|
||
**API Playground:** Можете сада приступити API Playground-у унутар подешавања апликације. Да бисте испробали API позиве у реалном времену, пријавите се у свој Twenty радни простор и идите на **Подешавања → API-и и вебхукови**. Ово отвара у апликацији API Playground и подешавања за API кључеве.
|
||
**[Идите на API подешавања](https://app.twenty.com/settings)**
|
||
|
||
## Аутентификација
|
||
|
||
API Twenty користи API кључеве за аутентикацију. Сваки захтев ка заштићеним крајњим тачкама мора укључивати API кључ у заглављу.
|
||
|
||
- **API кључеви:** Можете генерисати нови API кључ на страници вашег Twenty апликације **API подешавања**. Сваки API кључ је тајни токен који омогућава приступ вашим CRM подацима, зато га чувајте. Ако је кључ компромитован, опозовите га из подешавања и генеришите нови.
|
||
- **Аутх заглавље:** Када имате API кључ, укључите га у `Authorization` заглављу ваших HTTP захтева. Користите Bearer токен шему. На пример:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
Замените `YOUR_API_KEY` са кључем који сте добили. Ово заглавље мора бити присутно у **свим API захтевима**. Ако токен недостаје или је неисправан, API ће одговорити грешком при аутентикацији (HTTP 401 Неовлашћен приступ).
|
||
|
||
## API Крајње тачке
|
||
|
||
Сви ресурси могу бити приступљени кроз REST или GraphQL.
|
||
|
||
- **Облак:** `https://api.twenty.com/` или ваш прилагођени домен / поддомен
|
||
- **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/`).
|
||
|
||
Крајње тачке су груписане у две категорије: **Основни API** и **Метаподаци API**. **Основни API** се бави примарним CRM подацима (нпр. људи, компаније, белешке, задаци), док **Метаподаци API** покрива конфигурационе податке (као што су прилагођена поља или дефиниције објеката). Већина интеграција ће првенствено користити Основни API.
|
||
|
||
### Основни API
|
||
|
||
Приступачно на `/rest/` или `/graphql/`.
|
||
**Основни API** служи као јединствени интерфејс за управљање основним CRM ентитетима (људи, компаније, белешке, задаци) и њиховим односима, нудећи **обе REST и GraphQL** интеракције.
|
||
|
||
### Метаподаци API
|
||
|
||
Приступачан на `/rest/metadata/` или `/metadata/`.
|
||
Метаподаци API крајње тачке омогућавају вам да преузмете информације о вашој шеми и подешавањима. На пример, можете преузети дефиниције прилагођених поља, шеме објеката, и тако даље.
|
||
|
||
- **Пример Крајњих Тачака:**
|
||
|
||
- `GET /rest/metadata/objects` – Листа свих типова објеката и њихових метаподатака (поља, односи).
|
||
- `GET /rest/metadata/objects/{objectName}` – Преузимање метаподатака за одређени објекат (нпр., `људи`, `компаније`).
|
||
- `GET /rest/metadata/picklists` – Преузимање опција поља падајућег менија дефинисаних у CRM.
|
||
|
||
Типично, метаподаци крајње тачке се користе за разумевање структуре података (за динамичке интеграције или прављење формулара) уместо за управљање стварним записима. Оне су у већини случајева само за читање. За ове је такође потребна аутентикација (користите ваш API кључ). |