API

Tüm operasyonunuz için
bir REST API.

Anahtar başına izinlere sahip, kapsamı sınırlı bir REST API. Bearer token ile kimlik doğrulayın, modüllerinizi programatik olarak okuyup yazın ve her çağrıyı kullanım takibi ve erişim kayıtlarında izleyin.

Demo planla Dokümanları okuyun

Endpoints

Öngörülebilir, kaynak bazlı rotalar.

GET/api/modules/:id/records

Kayıtları listele (sayfalanmış, filtrelenmiş, sıralanmış)

POST/api/modules/:id/records

Bir kayıt oluştur

GET/api/modules/:id/records/:recordId

Tek bir kaydı getir

PATCH/api/modules/:id/records/:recordId

Bir kaydı güncelle

DELETE/api/modules/:id/records/:recordId

Bir kaydı sil

GET/api/modules

Bir anahtarın erişebildiği modülleri listele

İstek ve yanıt

Bearer token ile kimlik doğrulayın. Listeleme endpoint'leri sayfalanmış bir { data, total } zarfı döndürür.

GET /api/modules/:id/records?page=1&limit=20

Authorization: Bearer osc_live_…

200 OK

{

"data": [ … ],

"total": 248

}

Dokümanları aç

API anahtarları ve kapsamlar

Tasarım gereği en az yetki.

Anahtar başına kapsam

İhtiyacınız kadar anahtar oluşturun. Her biri modül başına okuma, yazma ve silme izinleriyle kapsamlandırılır — bir anahtar yalnızca dokunması gereken veriye dokunur.

Dakika başına hız sınırları

Her anahtar için ayarlanabilir bir dakika başına istek sınırı belirleyin; isteğe bağlı bir son kullanma tarihiyle, kısa ömürlü entegrasyonlar süresinden fazla yaşayamaz.

Kullanım ve erişim kayıtları

Her çağrı izlenir. Trafiği izlemek, entegrasyonları hata ayıklamak ve kimin neye dokunduğunu denetlemek için anahtar başına kullanımı ve tam erişim kayıtlarını inceleyin.

Hız sınırları ve kullanım

Öngörülebilir sınırlar, tam görünürlük.

Her anahtar, ayarlanabilir bir dakika başına hız sınırı ve isteğe bağlı bir son kullanma tarihi taşır. Kullanım, tam erişim kayıtlarıyla birlikte anahtar başına izlenir; böylece bir şeyler yolunda gitmediği an trafiği izleyebilir, entegrasyonları hata ayıklayabilir ve bir anahtarı döndürebilir veya iptal edebilirsiniz.

429 Too Many Requests

{

"error": "rate_limited",

"limit": 120,

"retry_after": 14

}

FAQ

API soruları

Her istek, Authorization başlığında bir Bearer token olarak bir API anahtarı taşır (örneğin, osc_live_…). Anahtarlar kiracı başına verilir ve isteğe bağlı bir son kullanma tarihi belirlemediğiniz sürece süresi dolmaz. Her istek, o anahtara verilen izinlerle sınırlıdır.

Evet. Her API anahtarının ayarlanabilir bir dakika başına hız sınırı vardır. Kullanım, tam erişim kayıtlarıyla anahtar başına izlenir; böylece trafiği izleyebilir, anormallikleri tespit edebilir ve anahtarları istediğiniz zaman döndürebilir veya iptal edebilirsiniz.

Anahtarlar, okuma, yazma ve silme izinleriyle modül başına kapsamlandırılır; böylece bir anahtar yalnızca dokunması gerekene dokunur. AI, REST API'den ayrıdır ve her planda dahildir — tercih ederseniz kiracı düzeyinde kendi Anthropic anahtarınızı (BYOK) getirebilirsiniz.

Collecta üzerine inşa edin.

Neyi bağlamak istediğinizi söyleyin — size bir anahtar, kapsamlar ve API'nin rehberli bir turunu sağlayalım.

Demo planla Dokümanları okuyun