Ana içeriğe atla

Kiracı başına şema API’leri

Twenty için statik bir API referansı yoktur. Her çalışma alanının kendine ait bir şeması vardır — özel bir nesne (ör. Invoice) eklediğinizde, Company veya Person gibi yerleşik nesnelerle aynı olan REST ve GraphQL uç noktalarını anında edinir. API şemadan oluşturulur, bu nedenle uç noktalar nesne ve alan adlarınızı doğrudan kullanır — anlaşılmaz kimlikler yoktur. Bir API anahtarı oluşturduktan sonra çalışma alanınıza özel API dokümantasyonu Ayarlar → API ve Webhook’lar altında mevcuttur. Verilerinize karşı gerçek çağrılar çalıştırabileceğiniz etkileşimli bir deneme alanı içerir.

İki API

Çekirdek API/rest/ ve /graphql/ Kayıtlar üzerinde CRUD: Kişiler, Şirketler, Fırsatlar ve özel nesneleriniz. Sorgulama, filtreleme, ilişkilerde gezinme. Meta veri API’si/rest/metadata/ ve /metadata/ Şema yönetimi: nesneleri, alanları ve ilişkileri oluşturma/değiştirme/silme. Programatik olarak veri modelinizi bu şekilde değiştirirsiniz. Her ikisi de REST ve GraphQL olarak mevcuttur. GraphQL, toplu upsert işlemleri ve ilişkilerde tek bir sorguda gezinme olanağı sağlar. Her iki yöntemde de aynı temel veri kullanılır.

Temel URL’ler

OrtamTemel URL
Buluthttps://api.twenty.com/
Kendi barındırmalıhttps://{your-domain}/

Kimlik Doğrulama

Authorization: Bearer YOUR_API_KEY
Settings → API & Webhooks → + Create key bölümünde bir API anahtarı oluşturun. Hemen kopyalayın — yalnızca bir kez gösterilir. Anahtarlar, erişebilecekleri alanları sınırlamak için Settings → Roles → Assignment sekmesi altında belirli bir role bağlanabilir. OAuth tabanlı erişim (kullanıcılar adına hareket eden harici uygulamalar) için bkz. OAuth.

Toplu işlemler

Hem REST hem de GraphQL, istek başına 60 kayda kadar toplu işlemeyi destekler — oluşturma, güncelleme veya silme. GraphQL ayrıca CreateCompanies gibi çoğul adlar kullanarak toplu upsert’i (tek çağrıda oluşturma veya güncelleme) destekler.

Hız sınırları

SınırDeğer
İsteklerDakikada 100
Toplu boyutuÇağrı başına 60 kayıt