Twenty a fost creat pentru a fi prietenos cu dezvoltatorii, oferind API-uri puternice care se adaptează la modelul dvs. de date personalizat. Oferim patru tipuri distincte de API-uri pentru a satisface diferite nevoi de integrare.
Developer-First Approach
Twenty generează API-uri special pentru modelul dvs. de date, ceea ce înseamnă:
- Nu sunt necesare ID-uri lungi: Utilizați direct numele obiectelor și câmpurilor în punctele finale
- Obiectele standard și personalizate tratate în mod egal: Obiectele dvs. personalizate primesc același tratament API ca și cele încorporate
- Puncte finale dedicate: Fiecare obiect și câmp primește propriul său punct final API
- Documentație personalizată: Generată special pentru modelul de date al spațiului dvs. de lucru
Your custom API generates personalized documentation accessible via Settings → API & Webhooks after creating an API key. Această documentație reflectă modelul dvs. exact de date și configurațiile câmpului.
Cele patru tipuri de API-uri
Twenty oferă API-uri în formate REST și GraphQL:
API-uri REST
- Scop: Gestionați structura spațiului dvs. de lucru și modelul de date
- Cazuri de utilizare:
- Creați, modificați sau ștergeți obiecte și câmpuri
- Configurați setările spațiului de lucru
- Gestionați relațiile modelului de date
- Acces: Disponibil prin punctele finale REST
2. API REST Core
- Scop: Gestionați înregistrările dvs. actuale de date
- Cazuri de utilizare:
- Creați, citiți, actualizați, ștergeți înregistrările
- Interogați date specifice
- Gestionați relațiile de înregistrări
- Acces: Disponibil prin punctele finale REST
API-uri GraphQL
- Scop: Același ca API REST Metadata, dar cu beneficii GraphQL
- Cazuri de utilizare: Aceeași gestionare a modelelor de lucru și a datelor
- Beneficii suplimentare:
- Query multiple metadata types in one request
- Selecție precisă a câmpurilor
- Performanță mai bună pentru interogări complexe
4. API GraphQL Core
- Scop: Același ca API REST Core, dar cu avantaje GraphQL
- Cazuri de utilizare: Aceeași gestionare a înregistrărilor de date
- Beneficii suplimentare:
- Operațiuni batch: Disponibil pentru toate operațiunile
- Operațiuni upsert: Creați sau actualizați înregistrările într-un singur apel
- Query relationships in single requests
- Acces precis la date
Operațiuni de grup
Suport pentru grup REST și GraphQL
Atât API-urile REST cât și GraphQL suportă operațiuni de grup pentru majoritatea acțiunilor:
- Dimensiunea grupului: Până la 60 de înregistrări pe cerere
- Operațiuni disponibile: Creați, actualizați, ștergeți mai multe înregistrări
- Performanță: Semnificativ mai rapid decât apelurile individuale API
Funcții exclusive GraphQL
- Inserare în grup: Disponibil doar în API-urile GraphQL
- Utilizare: Folosiți nume de obiecte la plural (de exemplu,
CreateCompanies în loc de CreateCompany)
- Cerință: Acesta este motivul pentru care numele de obiecte singulare și plural trebuie să fie distincte
Acces la documentația API
- Accesați Setări → API & Webhooks
- Creați o cheie API (necesară pentru accesul la documentație)
- Accesați documentația personalizată și spațiul de testare
- Testați API-urile cu modelul dvs. de date actual
Documentația dvs. este unică pentru spațiul dvs. de lucru deoarece reflectă obiectele, câmpurile și relațiile dvs. personalizate.
Când să folosiți fiecare API
- Configurați modelul dvs. de date
- Creați obiecte sau câmpuri personalizate
- Configurați setările spațiului de lucru
Utilizați API-urile principale când:
- Gestionați datele de zi cu zi (Persoane, Companii, Oportunități)
- Integrați cu sisteme externe
- Construiți aplicații personalizate
- Automating data workflows
Alegeți GraphQL când:
- Aveți nevoie de operațiuni de grup
- Doriți să minimizați apelurile API
- Aveți nevoie de funcționalitate upsert
- Construiți integrații complexe
Alegeți REST când:
- Preferiți o structură API mai simplă
- Construiți integrații de bază
- Echipa dvs. este mai familiarizată cu REST
- Aveți nevoie de operațiuni CRUD simple
Pașii următori
- Configurare API & Webhooks: Aflați cum să creați chei API și webhooks
- Documentație personalizată: Accesați documentația dvs. personalizată API prin Setări → API & Webhooks
