github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
4.9 KiB
Plaintext
131 lines
4.9 KiB
Plaintext
---
|
|
title: Visió general de les APIs
|
|
info: Understand the four different APIs and when to use each one.
|
|
image: /imatges/manual-d'usuari/api/api-overview.png
|
|
sectionInfo: Aprèn com connectar Twenty amb altres eines.
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Twenty està dissenyat per ser amigable per als desenvolupadors, oferint APIs potents que s'adapten al teu model de dades personalitzat. Proporcionem quatre tipus diferenciats d'API per satisfer diferents necessitats d'integració.
|
|
|
|
## Developer-First Approach
|
|
|
|
Twenty genera APIs específiques pel teu model de dades, el que significa:
|
|
|
|
- **No es requereixen IDs llargs**: Utilitza els noms dels objectes i camps directament en els punts finals
|
|
- **Els objectes estàndard i personalitzats es tracten igualment**: Els teus objectes personalitzats reben el mateix tractament API que els integrats
|
|
- **Punts finals dedicats**: Cada objecte i camp obté el seu propi punt final API
|
|
- **Documentació personalitzada**: Generada específicament per al model de dades del teu espai de treball
|
|
|
|
<Warning>
|
|
Your custom API generates personalized documentation accessible via Settings → API & Webhooks after creating an API key. Aquesta documentació reflecteix exactament el teu model de dades i configuracions de camps.
|
|
</Warning>
|
|
|
|
## Els Quatre Tipus d'APIs
|
|
|
|
Twenty ofereix APIs en formats **REST** i **GraphQL**:
|
|
|
|
### APIs REST
|
|
|
|
#### 1. API de Metadades REST
|
|
|
|
- **Propòsit**: Gestiona l'estructura del teu espai de treball i model de dades
|
|
- **Casos d'ús**:
|
|
- Crear, modificar o eliminar objectes i camps
|
|
- Configurar els ajustos de l'espai de treball
|
|
- Gestionar les relacions del model de dades
|
|
- **Accés**: Disponible a través dels punts finals REST
|
|
|
|
#### 2. API Central REST
|
|
|
|
- **Propòsit**: Gestiona els registres reals de dades
|
|
- **Casos d'ús**:
|
|
- Crear, llegir, actualitzar i eliminar registres
|
|
- Consultar dades específiques
|
|
- Gestionar relacions de registre
|
|
- **Accés**: Disponible a través dels punts finals REST
|
|
|
|
### APIs GraphQL
|
|
|
|
#### 3. API de Metadades GraphQL
|
|
|
|
- **Propòsit**: Igual que l'API de Metadades REST però amb els avantatges de GraphQL
|
|
- **Casos d'ús**: Mateixa gestió de l'espai de treball i del model de dades
|
|
- **Beneficis addicionals**:
|
|
- Consultar múltiples tipus de metadades en una sola sol·licitud
|
|
- Selecció precisa de camps
|
|
- Millor rendiment per a consultes complexes
|
|
|
|
#### 4. API Central GraphQL
|
|
|
|
- **Propòsit**: Igual que l'API Central REST però amb els avantatges de GraphQL
|
|
- **Casos d'ús**: Mateixa gestió de registres de dades
|
|
- **Beneficis addicionals**:
|
|
- **Operacions per lots**: Disponible per a totes les operacions
|
|
- **Operacions upsert**: Crear o actualitzar registres en una sola trucada
|
|
- Consultar relacions en sol·licituds individuals
|
|
- Extracció precís de dades
|
|
|
|
## Operacions per Lots
|
|
|
|
### Suport per Lots REST i GraphQL
|
|
|
|
Tant les APIs REST com les APIs GraphQL admeten operacions per lots per a la majoria d'accions:
|
|
|
|
- **Mida del lot**: Fins a 60 registres per sol·licitud
|
|
- **Operacions disponibles**: Crear, actualitzar, eliminar múltiples registres
|
|
- **Rendiment**: Significativament més ràpid que les trucades API individuals
|
|
|
|
### Característiques Exclusives de GraphQL
|
|
|
|
- **Insereix per lots**: Només disponible a les APIs GraphQL
|
|
- **Ús**: Utilitza noms d'objectes en plural (exemple: `CrearEmpreses` en lloc de `CrearEmpresa`)
|
|
- **Requisit**: Aquesta és la raó per la qual els noms d'objectes singulars i plurals han de ser diferents
|
|
|
|
## Accés a la Documentació API
|
|
|
|
1. Ves a **Configuració → API i Webhooks**
|
|
2. Crea una clau d'API (necessari per accedir a la documentació)
|
|
3. Accedeix a la teva documentació personalitzada i area de proves
|
|
4. Prova les APIs amb el teu model de dades real
|
|
|
|
La teva documentació és única pel teu espai de treball perquè reflecteix els teus objectes, camps i relacions personalitzats.
|
|
|
|
## Quan Utilitzar Cada API
|
|
|
|
### Utilitza APIs de Metadades quan:
|
|
|
|
- Configures el teu model de dades
|
|
- Creant objectes o camps personalitzats
|
|
- Configurant els ajustos de l'espai de treball
|
|
|
|
### Utilitza APIs Centrals quan:
|
|
|
|
- Gestionar dades diàries (Persones, Empreses, Oportunitats)
|
|
- Integrar-se amb sistemes externs
|
|
- Construir aplicacions personalitzades
|
|
- Automatitzar fluxos de treball de dades
|
|
|
|
### Tria GraphQL quan:
|
|
|
|
- Necessites operacions per lots
|
|
- Vols minimitzar les trucades a API
|
|
- Necessites funcionalitat upsert
|
|
- Estàs construint integracions complexes
|
|
|
|
### Tria REST quan:
|
|
|
|
- Prefereixes una estructura API més senzilla
|
|
- Estàs construint integracions bàsiques
|
|
- El teu equip coneix més REST
|
|
- Necessites operacions CRUD senzilles
|
|
|
|
## Propera Fase
|
|
|
|
- **[API & Webhooks Setup](/l/ca/user-guide/integrations-api/api-webhooks)**: Learn how to create API keys and webhooks
|
|
- **Documentació Personalitzada**: Accedeix als teus documents API personalitzats a través de Configuració → API i Webhooks
|
|
|