8cadd00d34
Created by Github action --------- Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
3.9 KiB
Plaintext
56 lines
3.9 KiB
Plaintext
---
|
||
title: API
|
||
image: /images/docs/getting-started/api.png
|
||
info: API'lerimizi nasıl kullanacağınızı keşfedin.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## Genel Bakış
|
||
|
||
Twenty API, geliştiricilerin Twenty CRM platformuyla programatik olarak etkileşimde bulunmasına olanak tanır. API'yi kullanarak Twenty'yi diğer sistemlerle entegre edebilir, veri senkronizasyonunu otomatikleştirebilir ve müşteri verilerinizi kullanarak özel çözümler oluşturabilirsiniz. API, temel CRM nesnelerini (**kişi ve şirketler gibi**) **oluşturma, okuma, güncelleme ve silme** işlemlerine yönelik uç noktalar sağlar ve ayrıca meta veri yapılandırmasına erişim sunar.
|
||
|
||
**API Playground:** Uygulamanın ayarlar bölümünden artık API Playground'a erişebilirsiniz. API çağrılarını gerçek zamanlı olarak denemek için, Twenty çalışma alanınıza giriş yapın ve **Ayarlar → API'ler & Webhooklar** yolunu izleyin. Bu, uygulama içi API Playground'u ve API anahtarlarının ayarlarını açar.
|
||
**[API Ayarlarına Git](https://app.twenty.com/settings)**
|
||
|
||
## Kimlik Doğrulama
|
||
|
||
Twenty'nin API'si kimlik doğrulama için API anahtarları kullanır. Korunmuş uç noktalara yapılan her istek, başlıkta bir API anahtarı içermelidir.
|
||
|
||
- **API Anahtarları:** Yeni bir API anahtarı oluşturmak için Twenty uygulamanızın **API ayarları** sayfasını kullanabilirsiniz. Her API anahtarı bir gizli jeton olup, CRM verilerinize erişim sağlar, bu yüzden güvende tutun. Bir anahtar tehlikeye girerse, ayarlardan iptal edin ve yenisini oluşturun.
|
||
- **Kimlik Doğrulama Başlığı:** Bir API anahtarını edindikten sonra, HTTP isteklerinizin `Authorization` başlığında ekleyin. Bearer token şemasını kullanın. Örneğin:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
`YOUR_API_KEY` ile elde ettiğiniz anahtarı değiştirin. Bu başlık **tüm API isteklerinde** bulunmalıdır. Jeton eksik veya geçersizse, API kimlik doğrulama hatası (HTTP 401 Yetkisiz) ile yanıt verir.
|
||
|
||
## API Uç Noktaları
|
||
|
||
Tüm kaynaklara REST veya GraphQL ile erişilebilir.
|
||
|
||
- **Bulut:** `https://api.twenty.com/` veya kendi özel alan adınız / alt etki alanı
|
||
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).
|
||
|
||
Uç noktalar iki kategoriye ayrılır: **Temel API** ve **Meta Veriler API**. **Temel API**, birincil CRM verileriyle ilgilenirken (ör. insanlar, şirketler, notlar, görevler), **Meta Veriler API** konfigürasyon verilerini kapsar (örneğin özel alanlar veya nesne tanımları). Çoğu entegrasyon öncelikle Temel API'yi kullanacaktır.
|
||
|
||
### Temel API
|
||
|
||
`/rest/` veya `/graphql/` üzerinden erişilebilir.
|
||
**Temel API**, çekirdek CRM varlıklarını (insanlar, şirketler, notlar, görevler) ve ilişkilerini yönetmek için birleşik bir arayüz olarak hizmet eder ve **hem REST hem de GraphQL** etkileşim modelleri sunar.
|
||
|
||
### Meta Veriler API
|
||
|
||
`/rest/metadata/` veya `/metadata/` üzerinden erişilebilir.
|
||
Meta Veriler API uç noktaları, şema ve ayarlarınızla ilgili bilgileri almanıza olanak tanır. Örneğin, özel alan tanımlarını, nesne şemalarını gibi bilgileri alabilirsiniz.
|
||
|
||
- **Örnek Uç Noktalar:**
|
||
|
||
- `GET /rest/metadata/objects` – Tüm nesne türlerini ve bunların meta verilerini listeleyin (alanlar, ilişkiler).
|
||
- `GET /rest/metadata/objects/{objectName}` – Belirli bir nesne için meta verileri alın (ör. `people`, `companies`).
|
||
- `GET /rest/metadata/picklists` – CRM'de tanımlanmış liste (açılır menü) alan seçeneklerini alın.
|
||
|
||
Genellikle meta veri uç noktaları, verilerin yapısı hakkında bilgi edinmek için kullanılır (dinamik entegrasyonlar veya form oluşturma) gerçek kayıtları yönetmekten ziyade. Çoğu durumda sadece okunabilirler. Bunlar için de kimlik doğrulama gereklidir (API anahtarınızı kullanın). |