github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
4.8 KiB
Plaintext
131 lines
4.8 KiB
Plaintext
---
|
||
title: API'lerin Genel Görünümü
|
||
info: Dört farklı API'yi ve her birini ne zaman kullanmanız gerektiğini anlayın.
|
||
image: /images/user-guide/api/api-overview.png
|
||
sectionInfo: Twenty'yi diğer araçlarınıza nasıl bağlayacağınızı öğrenin.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
||
</Frame>
|
||
|
||
Twenty, geliştirici dostu olacak şekilde tasarlanmıştır ve özel veri modelinize uyum sağlayan güçlü API'ler sunar. Farklı entegrasyon ihtiyaçlarını karşılamak üzere dört farklı API türü sunuyoruz.
|
||
|
||
## Öncelik Geliştiricide Yaklaşımı
|
||
|
||
Twenty, veri modeliniz için özel olarak API'ler oluşturur, yani:
|
||
|
||
- **Uzun kimlik numaralarına gerek yok**: Uç noktalarda nesne ve alan adlarınızı doğrudan kullanın
|
||
- **Standart ve özel nesneler eşit şekilde ele alınır**: Özel nesneleriniz yerleşik olanlarla aynı API muamelesini görür.
|
||
- **Özel uç noktalar**: Her nesne ve alan kendi API uç noktasına sahiptir
|
||
- **Özel dokümantasyon**: Çalışma alanınızın veri modeli için özel olarak üretilmiştir.
|
||
|
||
<Warning>
|
||
Your custom API generates personalized documentation accessible via Settings → API & Webhooks after creating an API key. Bu dokümantasyon, tam veri modelinizi ve alan yapılandırmalarınızı yansıtır.
|
||
</Warning>
|
||
|
||
## Dört API Türü
|
||
|
||
Twenty, **REST** ve **GraphQL** formatlarında API'ler sunmaktadır:
|
||
|
||
### REST API'ler
|
||
|
||
#### 1. REST Metadata API
|
||
|
||
- **Amaç**: Çalışma alanınızı ve veri modeli yapınızı yönetin
|
||
- **Kullanım alanları**:
|
||
- Nesne ve alanlar oluşturun, değiştirin veya silin
|
||
- Çalışma alanı ayarlarını yapılandırın
|
||
- Veri modeli ilişkilerini yönetin
|
||
- **Erişim**: REST uç noktalarından erişilebilir
|
||
|
||
#### 2. REST Core API
|
||
|
||
- **Amaç**: Gerçek veri kayıtlarınızı yönetin
|
||
- **Kullanım alanları**:
|
||
- Kayıtlar oluşturun, okuyun, güncelleyin, silin
|
||
- Belirli verileri sorgulayın
|
||
- Kayıt ilişkilerini yönetin
|
||
- **Erişim**: REST uç noktalarından erişilebilir
|
||
|
||
### GraphQL API'ler
|
||
|
||
#### 3. GraphQL Metadata API
|
||
|
||
- **Amaç**: REST Metadata API ile aynı, ancak GraphQL avantajlarıyla
|
||
- **Kullanım alanları**: Aynı çalışma alanı ve veri modeli yönetimi
|
||
- **Ek avantajlar**:
|
||
- Tek bir istekte birden fazla meta veri türünü sorgulayın
|
||
- Kesin alan seçimi
|
||
- Karmaşık sorgular için daha iyi performans
|
||
|
||
#### 4. GraphQL Core API
|
||
|
||
- **Amaç**: REST Core API ile aynı, ancak GraphQL avantajlarıyla
|
||
- **Kullanım alanları**: Aynı veri kaydı yönetimi
|
||
- **Ek avantajlar**:
|
||
- **Toplu işlemler**: Tüm işlemler için mevcut
|
||
- **Ekleme-Güncelleme işlemleri**: Tek bir çağrıda kayıt oluşturun veya güncelleyin
|
||
- Tekli isteklerde ilişkileri sorgulayın
|
||
- Kesin veri çekimi
|
||
|
||
## Toplu İşlemler
|
||
|
||
### REST ve GraphQL Toplu Destek
|
||
|
||
Hem REST hem de GraphQL API'leri, çoğu eylem için toplu işlemleri destekler:
|
||
|
||
- **Toplu boyut**: İstek başına 60 kayıt kadar
|
||
- **Mevcut işlemler**: Çoklu kayıt oluşturma, güncelleme, silme
|
||
- **Performans**: Bireysel API çağrılarından önemli ölçüde daha hızlı
|
||
|
||
### Yalnızca GraphQL Özellikleri
|
||
|
||
- **Toplu Ekleme-Güncelleme**: Yalnızca GraphQL API'lerinde mevcut
|
||
- **Kullanım**: Çoğul nesne adlarını kullanın (örneğin, `CreateCompanies` yerine `CreateCompany`)
|
||
- **Gereklilik**: Bu yüzden tekil ve çoğul nesne adları farklı olmalıdır
|
||
|
||
## API Dokümantasyonu Erişimi
|
||
|
||
1. Go to **Settings → API & Webhooks**
|
||
2. Dokümantasyon erişimi için bir API anahtarı oluşturun (gereklidir)
|
||
3. Özel dokümantasyonunuza ve çalışma alanınıza erişin
|
||
4. API'leri gerçek veri modelinizle test edin
|
||
|
||
Dokümantasyonunuz özel nesneleriniz, alanlarınız ve ilişkilerinizin yansıması olduğundan çalışma alanınıza özeldir.
|
||
|
||
## Her API'nin Ne Zaman Kullanılacağı
|
||
|
||
### Metadata API'leri kullanın:
|
||
|
||
- Veri modelinizi ayarlarken
|
||
- Özel nesneler veya alanlar oluştururken
|
||
- Çalışma alanı ayarlarını yapılandırırken
|
||
|
||
### Core API'leri kullanın:
|
||
|
||
- Günlük veri yönetiminde (İnsanlar, Şirketler, Fırsatlar)
|
||
- Dış sistemlerle entegrasyon
|
||
- Özel uygulamalar oluşturma
|
||
- Veri iş akışlarını otomatikleştirme
|
||
|
||
### GraphQL'i seçin:
|
||
|
||
- Toplu işlemlere ihtiyacınız varsa
|
||
- API çağrılarını en aza indirmek istiyorsanız
|
||
- You need upsert functionality
|
||
- Karmaşık entegrasyonlar oluşturuyorsanız
|
||
|
||
### REST'i seçin:
|
||
|
||
- Daha basit API yapısını tercih ediyorsanız
|
||
- Temel entegrasyonlar oluşturuyorsanız
|
||
- Ekibiniz REST ile daha tanıdıksa
|
||
- Basit CRUD işlemlerine ihtiyacınız varsa
|
||
|
||
## Sonraki Adımlar
|
||
|
||
- **[API & Webhooks Setup](/l/tr/user-guide/integrations-api/api-webhooks)**: Learn how to create API keys and webhooks
|
||
- **Özel Dokümantasyon**: Ayarlar → API & Webhooks üzerinden kişiselleştirilmiş API dokümanlarınıza erişin.
|
||
|