API Erişimi ve Kimlik Doğrulaması

SPREEAI, onaylanmış iş ortağı iş akışları için herkese açık bir API referansı sağlar: https://docs.spreeai.com/swagger/public/.

Erişim modeli

API kapsamı, ortamı, kimlik bilgileri ve izin verilen işlemler, iş ortağı katılımı sırasında kararlaştırılır. Üretimde dahili, gelişimsel veya tarihsel bir son noktanın mevcut olduğunu varsaymayın.

Kimlik bilgisi kuralları

• İstemci gizli bilgilerini ve erişim belirteçlerini yalnızca güvenli bir sunucu tarafı gizli bilgi deposunda saklayın.
• Kimlik bilgilerini asla Git'e, belgelere, sorun izleyicilere, ekran görüntülerine veya örnek uygulamalara aktarmayın.
• Kimlik bilgilerini asla analitik veya günlük platformlarına göndermeyin.
• Ortama özgü kimlik bilgilerini yalnızca verildikleri ortamda kullanın.
• Bir kimlik bilgisi açığa çıkarsa hemen döndürün.
• Yetkilendirme başlıklarını ve belirteçlerini destek isteklerinden çıkarın.

Tarayıcı ve sunucu

Web SDK, iş ortağı tarafından sağlanan tarayıcı yapılandırmasını kullanır. Tarayıcıya istemci gizli anahtarı eklenmemelidir.

Sunucu tarafı entegrasyonları, mevcut onaylı API referansındaki kimlik doğrulama akışını ve uç nokta tanımlarını takip etmelidir. Gerekli bir işlem mevcut değilse, belgelenmemiş bir rota oluşturmak yerine, bu işlemi İş Ortağı Mühendisliği aracılığıyla talep edin.

Web kancaları

Sunucuya yönelik web kancaları, şu anda yayınlanmış Web SDK belgelerinde yer almamaktadır. Herhangi bir web kancası gereksinimini, ona bağımlılık tasarlamadan önce doğrulayın.

Çevre kontrol listesi

• [ ] Ortam adı belgelenmiştir.
• [ ] Temel URL, onaylanmış referanstan veya işe alım devir tesliminden alınmıştır.
• [ ] Bu ortam için yetkilendirme belgeleri düzenlenmiştir.
• [ ] Sırlar sunucu tarafında saklanır.
• [ ] Günlükler, belirteçleri ve müşteri görsellerini gizler.
• [ ] Yazma işlemleri için zaman aşımı, yeniden deneme ve tekrarlanabilirlik davranışı konusunda anlaşmaya varıldı.
• [ ] Üretim erişimi kullanılmadan önce üretim dışı bir test başarılı olur.