Platform API’si

Şirket işletim sistemi, ajanlara iç verilere doğrudan erişim vermek yerine sürümlü sözleşmeler sunar. Bu platform uç noktaları abonelik, kullanım ve kaydı kapsar; modül servisleri denetimli iş araçlarını sağlar.

Kayıt sözleşmesi ve r72-B4 self servis faturalama backend’i uygulanmıştır. Faturalama, dağıtılan ortam için aşamalı yayın bayrağı onaylanana kadar varsayılan olarak kapalı kalır.

Aboneliği görüntüle

GET /api/v1/platform/subscription

Kimliği doğrulanmış çalışma alanının görebildiği kiracı-güvenli ticari durumu, döngüyü, dönemi, satın alınan modülleri, kullanımı ve yansıtılmış faturaları döndürür.

json

{
  "status": "ACTIVE",
  "cycle": "ANNUAL",
  "modules": [{ "code": "finance", "band": "C", "purchased": true }]
}

Genel kataloğu görüntüle

GET /api/v1/signup/catalogue

Yayımlanmış GBP fiyat kitabını, varsa bağımsız olarak yayımlanmış TRY kitabını, modül/bant kurallarını ve canlı kayıt bölgesi kullanılabilirliğini döndürür. İstemci hiçbir zaman tutar göndermez.

json

{
  "priceBooks": [{ "code": "GBP-UK", "currency": "GBP" }],
  "signupRegions": [{ "code": "uk-london", "available": true }]
}

Çalışma alanı adresini kontrol et

GET /api/v1/signup/slug-available?slug=northrig

Sınırlı bilgi ifşasıyla tek bir boolean döndürür. Uç nokta hız sınırlıdır ve rezervasyon kayıt talebi oluşturulurken atomik kalır.

json

{ "available": true }

Doğrulanacak kayıt talebi oluştur

POST /api/v1/signup/leads

İstenen çalışma alanını, kimlik modunu, marka başlangıç ayarlarını ve etkin bölgeyi kaydeder, ardından doğrulama gönderir. Doğrulamadan önce veritabanı oluşturmaz.

json

{
  "leadId": "opaque-status-proof",
  "verificationRequired": true
}

E-posta doğrulamasını kullan

POST /api/v1/signup/verify

Tek kullanımlık e-posta tokenını kullanır ve tahmin edilemeyen durum kanıtını döndürür. B3 doğrulama tokenını sorgu dizgilerinin dışında tutar.

json

{ "leadId": "opaque-status-proof", "verified": true }

Kurulum durumunu görüntüle

POST /api/v1/signup/status

Yerleşim bilgisini, veritabanı kimlik bilgilerini veya ham worker hatalarını açığa çıkarmadan B1 kurulum ilerlemesini yansıtmak için tahmin edilemeyen kayıt kanıtını kullanır.

json

{
  "leadId": "opaque-status-proof",
  "status": "provisioning",
  "activeStage": "schema_verified"
}

Çalışma alanı bulma e-postası gönder

POST /api/v1/signup/workspaces/email

Bir iş e-postasını kabul eder ve her zaman aynı genel kabul sonucunu döndürür. Çalışma alanı adları ve teslimat sonuçları yalnızca bant dışı kanalda kalır.

json

{ "accepted": true }

Webhook olayları

Her ticari durum değişikliği kalıcı olarak kaydedildikten sonra yayınlanır. Tüketiciler olay kimliğine göre tekilleştirmelidir.

Olay	Ne zaman
subscription.updated	Sepet, bant, dönem veya durum değiştiğinde
usage.threshold_reached	Bir faturalama metriği yapılandırılmış uyarı eşiğine ulaştığında
invoice.paid	Yansıtılmış platform faturası ödendiğinde
workspace.ready	Provisioning tamamlanıp ilk yönetici davet edildiğinde