Herkese Açık API

Herkese Açık API, Blueputto'nun kimliği doğrulanmış entegrasyon katmanıdır. Uygulamanın her gün çalıştığı aynı temel kayıtları açığa çıkarır; bu da harici sistemlerin, kullanıcı arayüzünün yanında ikinci bir içerik modeli oluşturmadan operasyonel verileri oluşturmasına, okumasına, güncellemesine ve kaldırmasına olanak tanır.

Bu API, /v1 altında yer alır ve kuruluş düzeyindeki API Keys ile çalışacak şekilde tasarlanmıştır. Bu da onu, Blueputto verilerinin bir web sitesine, otomasyona, içe aktarma betiğine, dahili kontrol paneline veya başka bir ürün sistemine taşınması gerektiğinde ekiplerin kullandığı özellik haline getirir.

Ana çalışma alanı kaynakları için tek bir sürümlenmiş API

/v1 giriş noktası; API sürümü, kimlik doğrulama biçimi, OpenAPI belge URL'si ve şu anda kullanıma sunulan kaynakların listesini içeren kompakt bir keşif yükü döndürür.

Mevcut uygulamada, herkese açık yüzey şunları kapsar:

• belgeler,

• öğeler,

• koleksiyonlar,

• klasörler,

• kategoriler,

• durumlar,

• etiketler,

• ve belge şablonları.

Bu kaynakların çoğu; listeleme, getirme, oluşturma, güncelleme ve silme şeklindeki standart operasyonel akışı destekler. API ayrıca, kullanıcı arayüzünün ihtiyaç duyduğu yerlerde iş akışına özgü eylemleri de sunar; örneğin:

• belgeler ve öğeler için geri yükleme ve kalıcı silme,

• belgeler için çoğaltma,

• kategoriler, durumlar ve etiketler için yeniden sıralama,

• ve belge şablonları için yalnızca aktif filtreleme.

Herkese Açık API'yi salt okunur bir dışa aktarma katmanından daha fazlası yapan şey budur. Doğrudan Blueputto'nun kendisinde zaten görünen gerçek kayıt yaşam döngüsüyle yakın şekilde eşleşir.

Blueputto Public API kök yanıtı ve sürümlü API yüzeyi için OpenAPI belgesi.

Kimlik doğrulama ve yanıt biçimi öngörülebilir kalır

Herkese Açık API, kuruluş kimlik bilgisini iki standart biçimden biriyle kabul eder:

• x-api-key,

• veya Authorization: Bearer <key>.

Bu, ekiplerin Blueputto'yu farklı çalışma zamanlarına, ağ geçitlerine ve SDK stillerine bağlarken esneklik kazanmasını sağlar. Anahtarın kendisi, uygulama içinden API Keys ayarlar sayfasında oluşturulur.

Yanıt biçimi de kasıtlı olarak tutarlıdır. Tek kaynaklı yanıtlar bir data zarfı içinde döndürülür. Liste uç noktaları, data ile birlikte meta da döndürür; bu da page, limit, total items, total pages ve next veya previous page durumu gibi sayfalama ayrıntılarını içerir.

Mevcut kaynak kümesinde API ayrıca, gerçek kullanıcı arayüzü iş akışlarını yansıtan arama, deletedOnly, folderId, withoutFolder ve activeOnly gibi pratik filtreler de sunar.

API anahtarıyla kimlik doğrulamayı ve sayfalandırılmış yanıt zarflarını gösteren kimliği doğrulanmış Blueputto Public API isteği.

Uygulamayla aynı operasyonel kurallar etrafında oluşturuldu

Blueputto'nun Herkese Açık API'sinin faydalı yanı yalnızca kayıtlara harici olarak erişilebilmesi değildir. Entegrasyon yüzeyinin, ürünün kullanıcı arayüzünde zaten uyguladığı aynı kuralları izlemesidir.

Örneğin, belge ve öğe silme işlemi anında yok etme yerine önce çöp kutusuna taşıma akışı olarak modellenmiştir. Bazı belge işlemleri, kayıt o anda düzenlenebilir değilse kilitli durum yanıtı döndürebilir. Hız sınırlaması her API anahtarı için uygulanır; varsayılan arka uç sınırı şu anda anahtar başına 5 req/s olarak ayarlanmıştır.

Bu, API'nin gerçek uygulama davranışıyla uyumlu kalmasını sağlar. Harici entegrasyonlar, üründen farklı davranan basitleştirilmiş bir yan kanal yerine Blueputto'nun gerçek kaynak modeliyle çalışır.

İlgili

• API Keys

• Documents

• Items

• Document Templates