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: Descobriu com utilitzar les nostres APIs.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Visió general
|
||
|
||
El Twenty API permet als desenvolupadors interactuar programàticament amb la plataforma Twenty CRM. Utilitzant l'API, podeu integrar Twenty amb altres sistemes, automatitzar la sincronització de dades i construir solucions personalitzades al voltant de les dades dels vostres clients. L'API proporciona punts finals per **crear, llegir, actualitzar i eliminar** els objectes centrals de CRM (com persones i empreses) així com accedir a la configuració de metadades.
|
||
|
||
**API Playground:** Ara podeu accedir al API Playground dins de la configuració de l'aplicació. Per provar les trucades API en temps real, inicieu sessió a l'espai de treball de Twenty i aneu a **Configuració → APIs i Webhooks**. Això obre el API Playground integrat a l'aplicació i la configuració de les claus d'API.
|
||
**[Anar a la Configuració d'API](https://app.twenty.com/settings)**
|
||
|
||
## Autenticació
|
||
|
||
L’API de Twenty utilitza claus d'API per a l'autenticació. Cada sol·licitud a punts finals protegits ha d'incloure una clau API a l'encapçalament.
|
||
|
||
- **Claus API:** Podeu generar una nova clau API des de la pàgina de **configuració de l'API** de la vostra aplicació Twenty. Cada clau API és un token secret que permet accedir a les vostres dades de CRM, així que manteniu-la segura. Si una clau es veu compromesa, revoqueu-la des de la configuració i genereu-ne una de nova.
|
||
- **Encapçalament Auth:** Un cop tingueu una clau API, incloeu-la a l'encapçalament `Authorization` de les vostres sol·licituds HTTP. Feu servir l'esquema del token Bearer. Per exemple:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
Substituïu `YOUR_API_KEY` per la clau que heu obtingut. Aquest encapçalament s'ha de presentar en **totes les sol·licituds API**. Si el token falta o és invàlid, l'API respondrà amb un error d'autenticació (HTTP 401 Unauthorized).
|
||
|
||
## Punts finals de l'API
|
||
|
||
Tots els recursos es poden accedir mitjançant REST o GraphQL.
|
||
|
||
- **Cloud:** `https://api.twenty.com/` o el vostre domini / subdomini personalitzat
|
||
- **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/`).
|
||
|
||
Els punts finals es classifiquen en dues categories: **API bàsica** i **API de Metadades**. L'**API Central** tracta amb les dades primàries de CRM (per exemple, persones, empreses, notes, tasques), mentre que l'**API de Metadades** cobreix dades de configuració (com a camps personalitzats o definicions d'objectes). La majoria d'integracions utilitzaran principalment l'API Central.
|
||
|
||
### API Central
|
||
|
||
Accessible a `/rest/` o `/graphql/`.
|
||
L'**API Central** serveix com a interfície unificada per gestionar entitats centrals de CRM (persones, empreses, notes, tasques) i les seves relacions, oferint models d'interacció **tant de REST com GraphQL**.
|
||
|
||
### API de Metadades
|
||
|
||
Accessible a `/rest/metadata/` o `/metadata/`.
|
||
Els punts finals de l'API de Metadades us permeten obtenir informació sobre el vostre esquema i configuració. Per exemple, podeu obtenir les definicions dels camps personalitzats, esquemes d'objectes, etc.
|
||
|
||
- **Exemples de Punts Finals:**
|
||
|
||
- `GET /rest/metadata/objects` – Llista tots els tipus d'objectes i les seves metadades (camps, relacions).
|
||
- `GET /rest/metadata/objects/{objectName}` – Obté les metadades per a un objecte específic (per exemple, `people`, `companies`).
|
||
- `GET /rest/metadata/picklists` – Obtén les opcions de camp desplegable definides al CRM.
|
||
|
||
Normalment, els punts finals de metadades s'utilitzen per entendre l'estructura de dades (per a integracions dinàmiques o creació de formularis) més que per gestionar registres reals. Són només de lectura en la majoria dels casos. També es requereix autenticació per a aquests punts (utilitzeu la vostra clau API). |