DepthFeed.

Bir piyasa verisi ürünü sadece bir fiyat döndürmekten fazlasını yapmalıdır. Bir araştırmacının bir piyasayı keşfetmesi, doğru tanımlayıcıyı seçmesi, nelerin yakalandığını anlaması ve kullanılabilir bir geçmiş elde etmesi gerekir. Web sitesi, dokümantasyon ve API aynı sözleşmeyi açıklamalıdır.

DepthFeed, keşif ve araştırma için bir ürüne tahmin piyasası meta verilerini ve kaydedilmiş emir defteri geçmişini getirir. Dokümantasyonu önemli bir ayrım yapar: Bir uç noktanın başarıyla dönmesi, altta yatan verinin eksiksiz olduğunu kanıtlamaz.

Proje, hizmet veren API'leri, toplama ve tarihsel veri alımını, genel web sitesini ve hesap deneyimini ve istemci örneklerini ayırır. Bu ayrım, genel açıklamanın ve uygulamanın tanımlanmış arayüzler etrafında evrilmesine olanak tanır.

Belgelenmiş entegrasyon, REST keşif ve geçmiş verilerini, normalize edilmiş WebSocket defterleri ve fiyatlarla birlikte içerir. Hesap politikası, tanımlayıcılar, imleçler ve zaman damgaları açıkça belirtilmiştir; böylece istemci, servisin nasıl çalıştığını tahmin etmek zorunda kalmaz.

Mekan etiketleri ve tanımlayıcılarının farklı kaynaklarda aynı anlama geldiği varsayılmaz. Dokümantasyon, aday ilişkisini onaylanmış sözleşme eşdeğerliğinden ayırır ve hâlâ inceleme gerektiren durumları belirtir.

Bu hem bir ürün tasarımı kararı hem de bir mühendislik kararıdır. Kullanıcı, bir karşılaştırma veya analiz oluşturmadan önce bir kaydın neyi destekleyebileceğini bilmelidir. Net durumlar, belirsiz bilgileri kesinleşmiş gibi sunmaktan daha faydalıdır.

Çalışma, bilgi modelini web sitesine, hesap kontrollerine, API dokümantasyonuna ve entegrasyon örneklerine bağlar. Ürün geliştirmenin neden görünür deneyim ile arkasındaki sistemler arasında tutarlı dil ve duruma ihtiyaç duyduğunu örneklendirir.

Teslimat dersi, dokümantasyonu ve istisna durumlarını ürünün bir parçası olarak ele almaktır. Bir entegrasyon sözleşmesi, yalnızca başarılı bir isteği tarif etmek yerine eksik kapsamı, kimliği ve kurtarma süreçlerini açıklamalıdır.

DepthFeed'un genel ürün ve entegrasyon dokümantasyonu, piyasa kayıtlarının, bir API'nin ve bir araştırma arayüzünün nasıl bir araya geldiğini gösterir. Aşağıdaki bağlantılar mevcut ürün bağlamını ve entegrasyon referansını sağlar.

Kapsam ve kullanılabilirlik, mekana ve piyasaya göre değişir. Bir veri entegrasyonu, gerekli kaynağı, zaman aralığını ve erişim yöntemini mevcut dokümantasyona karşı kontrol ederek başlar.