Salt la conținutul principal

​
API-uri cu schemă per-tenant

Nu există o referință API statică pentru Twenty. Fiecare spațiu de lucru are propria schemă — când adaugi un obiect personalizat (de exemplu Invoice), acesta primește imediat endpoint-uri REST și GraphQL identice cu cele ale obiectelor încorporate precum Company sau Person. API-ul este generat din schemă, astfel încât endpoint-urile folosesc direct denumirile obiectelor și câmpurilor tale — fără ID-uri opace. Documentația API specifică spațiului tău de lucru este disponibilă în Settings → Developers → API după crearea unei chei API. Include un mediu interactiv de testare în care poți executa apeluri reale asupra datelor tale.

​
Două API-uri

API de bază — /rest/ și /graphql/ CRUD pe înregistrări: Persoane, Companii, Oportunități, obiectele tale personalizate. Interogare, filtrare, parcurgere a relațiilor. API de metadate — /rest/metadata/ și /metadata/ Administrarea schemei: creare/modificare/ștergere de obiecte, câmpuri și relații. Așa îți modifici programatic modelul de date. Ambele sunt disponibile ca REST și GraphQL. GraphQL adaugă upsert-uri în lot și posibilitatea de a parcurge relațiile într-o singură interogare. Aceleași date de bază, indiferent de metodă.

​
URL-uri de bază

​
Autentificare

Creează o cheie API în Settings → Developers → API → + Create key. Copiază-o imediat — este afișată o singură dată. Cheile pot fi limitate la un rol specific în Settings → Members → Roles → Assignment tab pentru a restricționa la ce pot avea acces. Pentru acces bazat pe OAuth (aplicații externe care acționează în numele utilizatorilor), vezi OAuth.

​
Operațiuni de grup

Atât REST, cât și GraphQL acceptă procesarea în lot de până la 60 de înregistrări per cerere — creare, actualizare sau ștergere. GraphQL acceptă, de asemenea, upsert în lot (creare-sau-actualizare într-un singur apel) folosind nume la plural precum CreateCompanies.

​
Selectarea câmpurilor (REST)

Endpointurile de înregistrări REST acceptă un parametru de interogare fields pentru a returna numai câmpurile de care aveți nevoie:
  • id este returnat întotdeauna.
  • Câmpurile compuse (precum emails sau name) sunt selectate în întregime după numele câmpului lor.
  • Un câmp de relație mulți-la-unu returnează coloana sa de asociere (de exemplu, companyId) cu depth=0. Câmpurile de relație unu-la-mulți sunt returnate numai cu depth=1. Cu depth=1, sunt extinse doar câmpurile de relație enumerate în fields.
  • Câmpurile necunoscute sau câmpurile pe care rolul dvs. nu le poate citi returnează o eroare 400.
Când fields este omis pentru un obiect cu mai mult de 200 de câmpuri care pot fi citite, fiecare înregistrare returnează un set implicit de 200 de câmpuri: id, câmpurile identificatorului etichetei și imaginii, createdAt, updatedAt, deletedAt, position, apoi câmpurile standard înaintea câmpurilor personalizate, ordonate după nume. Transmiteți explicit fields pentru a citi orice câmp dincolo de acel set implicit.

​
Limitări de rată