Kılavuzlar

Kimlik doğrulama

Tek başlık, tek anahtar ve erişimi daraltabilecek birbirinden bağımsız dört şey.

Başlık

Kimlik doğrulayan her çağrı anahtarı bearer token olarak taşır. OAuth akışı yok, yenileme token'ı yok, oturum yok. Kimlik bilgisinin tamamı anahtardır. Ayarlar → API anahtarları sayfasından oluşturulur ve yalnızca bir kez gösterilir; pencereyi kapatmadan kaydedin.

Authorization: Bearer sek_0b9a4d182c0f6b9a…

Hangi kapıların açılacağına kapsam karar verir

Kapsam, controller çalışmadan önce denetlenir ve varsayılan reddetmektir. full olmayan bir anahtar yalnızca kapsamının saydığı uçlara ulaşır, başka hiçbir yere. Anahtar bir acentenin ofisindeki bilgisayarda duruyorsa asıl fark budur.

full

Ulaştığı uçlar

Bu referanstaki bütün uçlar.

ticket_import

Ulaştığı uçlar

/api/v1/ticket_imports

import

Ulaştığı uçlar

/api/v1/imports
/api/v1/imports/entities
/api/v1/imports/entities/{key}
/api/v1/imports/{entity}
/api/v1/imports/{entity}/records
/api/v1/imports/{entity}/records/{external_id}
/api/v1/imports/{entity}/validate
/api/v1/imports/{id}
/api/v1/imports/{id}/rows
/api/v1/workspace

İçeri girdikten sonra ne yapabileceğinize rol karar verir

Kapsam ile rol farklı sorulara cevap verir. Acente isterse anahtarı kendi rollerinden birine bağlar; o zaman o rolün izin kümesi geçerli olur. Rolün kapsamadığı bir işlem 403 forbidden döner, rolün göremediği para ve kişisel veri alanları ise gizlenmek yerine null gelir. Rol bağlanmamış bir anahtar, hesap sahibinin kısıtsız izinleriyle çalışır.

Anahtarı daraltmanın üç yolu daha

IP listesi: Anahtarı çağrı yapacağı adreslere bağlayın. Başka bir yerden gelen çağrı 403 ip_not_allowed alır. Kimlik bilgisi sağlamdır, yani başka bir token denemek yanlış hamledir.
Son kullanma: Anahtara bir bitiş tarihi verin. Tarih geçtiğinde her çağrı 401 key_expired döner ve tarihi söyler.
İptal: Kaydı silmeden anahtarı kapatın; böylece isim ve kullanım geçmişi olaydan sonra da elinizde kalır. Çağrılar 401 key_revoked alır.

Rotasyon

Yeni anahtar verilmesi eskisini anında kesmez. Eski anahtar 48 saat daha çalışır. Bu süre yeni değeri mesai içinde yayına almaya yeter, "geçen hafta rotasyon yaptık" cümlesinin eskisinin gerçekten gittiği anlamına gelmesi için de yeterince kısadır.

Bunların hepsinin üstünde plan kapısı var

API erişimi plana bağlı bir özelliktir. İçermeyen bir hesapta kapsam ya da rol ne olursa olsun her çağrı 403 plan_upgrade_required döner. Kapsamdan önce denetlenir; o yüzden ilk göreceğiniz hata budur.