Network Northwest

Entegrasyon · API

Bilerek sıkıcı.

HTTPS üzerinden REST, giriş ve çıkışta JSON, tarihli sürümler, idempotent yazmalar ve hangi alanın hatalı olduğunu söyleyen hatalar. Burada kaynaklardan başka öğrenilecek bir şey yok; niyet de bu.

  • RESTHTTPS üzerinden
  • 24 saatidempotentlik penceresi
  • 90 günkullanım dışı bildirimi

Sözleşme

Güveneceğiniz parçalar

Sürümleme
Tarihli, anahtar başına sabitlenir

Bir anahtar bir sürüme sabitlenir. Siz geçene kadar yeni sürümler size ulaşmaz ve bir sürüm, ardılı duyurulduktan sonra en az 90 gün desteklenir.

İdempotentlik
Idempotency-Key, 24 saat

Bir oluşturma isteğinin yeniden gönderilmesi ilk doğrulamayı döndürür. Bir arıza sırasındaki yeniden deneme fırtınası, tek bir oyuncu için beş doğrulama açamaz.

Hatalar
Alan düzeyinde, makine okunur

Bir 422, alanı ve ihlal ettiği kuralı adıyla söyler. Hiçbir şey, gövdesinde düz yazı bulunan çıplak bir 400 döndürmez.

Hız sınırları
Anahtar başına, her yanıtta başlıklar

Kalan ve sıfırlanma değerleri her zaman vardır; böylece bir istemci, durması söylenmeden önce yavaşlayabilir.

Kimlik doğrulama
Bearer anahtarı, yalnızca sunucu tarafında

Anahtarlar hiçbir zaman bir tarayıcıya veya el cihazına ulaşmaz; istemci onun yerine kısa ömürlü adım token'ları alır.

Saat
UTC, RFC 3339

Her veri yükündeki ve her kanıt dosyasındaki her zaman damgası — yerel saat varyantı yok.

Kaynaklar

Yüzeyin tamamı

Yöntem ve yolİşleviİdempotent
POST /v1/checksBir pazarda bir kişi için doğrulama açarEvet, 24 saat
GET /v1/checks/{id}Mevcut durum, karar ve gerekçeler—
POST /v1/checks/{id}/cancelHâlâ toplama aşamasındaki bir doğrulamayı bırakırEvet
GET /v1/evidence/{id}Bir kararın arkasındaki mühürlü kanıt dosyası—
GET /v1/eventsBir webhook'un teslim edemediği her şey için günlük—
POST /v1/policiesBir pazar için politika sürümü yayımlarEvet
POST /v1/exclusionsYetkili kaynağın siz olduğu yerde dışlama dosyanızı yayımlarEvet

Yedi kaynak. Bundan fazlasına ihtiyaç duyan bir doğrulama API'si, genellikle sizin probleminizi değil kendi iç yapısını sergiliyordur.

Kararlar

Neden bu biçimde

Yanıt neden akış olarak verilmiyor?

Çünkü yavaş olan taraf biz değil, oyuncu. Bir doğrulama, pasaportunu arayan bir insanı bekler; bunun için bir bağlantıyı açık tutmak size maliyet, ikimize de kırılganlık demektir. Webhook tam bu yüzden var.

Karar neden bir puan içermiyor?

Tek tek sinyallerin puanlarını, kanıt dosyasının içinde içerir. Yapmadığı şey, bunları tek bir sayıya indirgemektir; çünkü sonradan bir denetim otoritesine açıklanamayan şey tam olarak o tek sayıdır.

Bir politikayı bir doğrulamaya geriye dönük olarak sabitleyebilir miyiz?

Hayır. Doğrulama, kendisine karar veren politika sürümünü kaydeder ve bu kayıt değiştirilemez. Yeni bir politikayla yeniden karar vermek, eskisine atıf yapan yeni bir doğrulama açar.