API hedef kitleleri ve uyumluluk
Hangi VoiceStudio arayüzlerinin herkese açık, yalnızca tarayıcıya yönelik veya hiçbir zaman müşterilere açık olmadığı.
Her kontrol düzlemi işlemi bir hedef kitleye aittir. Ortak OpenAPI kaynağı bir işlemi herkese açık yapmaz.
| Hedef kitle | Rotalar | Kim çağırır | Burada yayımlandı mı? |
|---|---|---|---|
| Herkese açık geliştirici API'si | /v1/* | Kapsamı sınırlı geliştirici kimlik bilgisi | Evet, Cloud projeksiyonunda |
| Web sitesi uç API'si | İncelenmiş anonim /v1/marketing/* | Sitenin kendi formları | Hayır |
| Pano/BFF API'si | /dashboard/v1/* | Aynı kaynaktan oturum kullanan pano | Hayır |
| Operatör API'si | İncelenmiş /internal/v1/* | Platform operatörleri | Hayır |
| Dahili servis API'si | Diğer /internal/v1/* | Özel servisler | Hayır |
Web sitesi uç, operatör ve dahili rotalar hiçbir zaman müşteri API yüzeyi değildir. Yalnızca onların kullandığı şemalar dahil /cloud-openapi.json içinde bulunmazlar. Tarayıcılar hiçbir zaman geliştirici kimlik bilgisi almaz ve genel istemciler pano oturum çerezini kullanmaz.
Uyumluluk
Ürünler arası uyumluluk alt kümesi yayımlanmadı. Yerel 0.5.0 ve Cloud önizleme 1.0.0 sözleşmelerinin ikisinde de POST /v1/audio/transcriptions bulunur, ancak alanların, kimlik doğrulamanın, Artifact ve Job davranışının, zaman aşımlarının ve hataların birbirinin yerine geçebileceği belirtilmemiştir. Bunun için #71 davranış testlerinin belirtilen sürüm çifti için geçmesi gerekir. O zamana kadar ortak rota adı uyumluluk değil, örtüşmedir.
Cloud'u yayımlama
OpenAPI belgesinde veya çalıştırılabilir örneklerde etkin Cloud sunucusu yayımlamak bir sürüm adımıdır. Sırayla şunlar gerekir:
- Doğrulanmış üretim DNS ve TLS.
- Kimlik doğrulama, genel yönlendirme ve müşteri için güvenli hatalar için temel testler.
- Tam sürümler için #71 uyumluluk ve geri alma kontrolleri.
- Artık
unavailabledemeyen yeniden oluşturulmuş bir projeksiyon.
Geri alma etkin sunucuyu kaldırır. Kalıcı Jobs, Artifacts ve idempotency kayıtları olduğu gibi kalır.