MoraselGeliştiriciler için Morasel API'si
Ekibinizin kullandığı aynı kayıtları — konuşmalar, müşteriler, randevular, siparişler — kapsamını belirlediğiniz, IP ile kısıtladığınız ve kendi takviminize göre süresini doldurduğunuz token'larla okuyun ve üzerinde işlem yapın.
Kapsamsız, süresiz bir anahtar neden risktir
Kapsamı, IP kısıtlaması ve son kullanma tarihi olmayan tek bir API anahtarı sürekli bir risktir: sızarsa, onu bulan kişi çalışma alanının izin verdiği her şeyi okuyabilir ya da yazabilir. Çoğu entegrasyon bu erişimin yalnızca bir kısmına, sabit bir süre için, bilinen sistemlerden ihtiyaç duyar.
- Tam erişimli bir token, bir entegrasyonun hiç ihtiyaç duymadığı kayıtları okuyabilir ya da yazabilir.
- Süresiz bir token, onu oluşturan proje bittikten bir yıl sonra bile hâlâ geçerlidir.
- Herhangi bir IP'den kullanılabilen bir token, düz metni nereye sızarsa oradan yeniden kullanılabilir.
- Düz metnini artık kimsenin bulamadığı bir anahtar kontrol edilemez, yalnızca iptal edilip değiştirilebilir.
Morasel her token için neyi kaydeder
Entegrasyon başına bir token kaydı, böylece bir sahip onu oluşturan ekibe sormadan neyi yapabildiğini ve en son ne zaman kullanıldığını görür.
- Token adı
- Ekibinizin token'a verdiği ve ait olduğu entegrasyona bağlı etiket.
- Önek
- Oluşturulduktan sonra sırrı olmadan tanımlanabilmesi için gösterilen token'ın ilk karakterleri.
- Kapsamlar
- Token'ın erişebildiği nesneler ve eylemler; varsayılan okuma erişimi, yazma kapsamları nesne başına verilir.
- IP izin listesi
- Token'ın kullanılabileceği en fazla 20 adres; boşsa IP kısıtlaması yoktur.
- Son kullanma tarihi
- Sonrasında token'ın çalışmayı durduracağı, en fazla 365 gün ilerideki bir tarih.
- Son kullanım
- Bu token ile bir isteğin kimlik doğrulaması yaptığı en son zaman.
- Webhook uç noktası
- Entegrasyonunuz için çalışma alanından kaydettiğiniz URL ve imza gizli anahtarı.
Bir token oluşturmaktan döndürmeye
Düz metin sır yalnızca oluşturulurken bir kez vardır. Bundan sonrası önek ve belirlediğiniz kapsamlar üzerinden yürür.
Bir token oluşturun (sahip)
Adlandırın, kapsamlarını seçin, isteğe bağlı olarak bir IP izin listesi ve en fazla 365 günlük bir son kullanma tarihi belirleyin.
Sırrı bir kez kopyalayın
Tam token yalnızca bir kez gösterilir. Sonrasında kayıtta yalnızca öneki görünür.
REST API'yi Bearer başlığıyla çağırın
İstekleri belgelenmiş uç noktalara karşı doğrulayın; her çağrı token'ın kapsamlarına ve IP izin listesine göre kontrol edilir.
Bir webhook uç noktası kaydedin ve imza gizli anahtarını saklayın
Uç nokta URL'sini çalışma alanından ekleyin ve verdiği imza gizli anahtarını saklayın.
Döndürün: halefi oluşturun, eskisini iptal edin
Eski token süresi dolmadan ya da ele geçirilmeden önce yeni bir token verin, yenisi devreye girdikten sonra eskisini iptal edin.
Müşterinin gördüğü şey
API üzerinden gönderilen bir mesaj, çalışma alanından gönderilen bir mesajla tamamen aynı görünür — müşterinin ayırt etmesinin bir yolu yoktur.
Ekibinizin gördüğü şey
Bir token'ın etkinliği bir kayıttır, günlüklerdeki bir gizem değil.
- Her token'ın kapsamları, IP izin listesi, son kullanma tarihi ve son kullanım zamanı, tek bir kayıtta.
- Webhook uç noktası ve imza gizli anahtarını gösterme ya da döndürme seçeneği.
- Sırra bir daha hiç ihtiyaç duymadan bir token'ı sohbette tanımlamak için bir önek.
- Çalışma alanındaki her şeyle aynı denetim kaydında oluşturma ve iptal olayları.
Kim neyi yapabilir
Erişim verme ve iptal etme yalnızca çalışma alanının sahiplerine aittir ve her değişiklik kaydedilir.
- Yalnızca bir çalışma alanı sahibi bir API token'ı oluşturabilir ya da iptal edebilir.
- Kapsamlar varsayılan olarak okumadır; bir nesneye yazma erişimi açıkça verilir, varsayılmaz.
- Belirlendiğinde bir IP izin listesi, bir token'ı en fazla 20 bilinen adresle sınırlar.
- Her token oluşturma ve iptali, kimin ne zaman yaptığıyla birlikte denetim kaydındadır.
Morasel'in yapmadığı şey
Webhook uç noktaları çalışma alanından bir imza gizli anahtarıyla kaydedilir. Morasel SDK yayımlamaz; REST API OpenAPI olarak belgelenir. Bir uç noktayı kaydetmek, entegrasyonunuz için onun URL'sini ve imza gizli anahtarını saklar.
Morasel üzerine inşa etmeye başlayın
Bir çalışma alanı oluşturun, kapsamı belirlenmiş bir token verin ve ihtiyacınız olan uç noktalar için OpenAPI referansını okuyun.
Geliştirici soruları
Bir token'ı nasıl alırım?
Bir çalışma alanı sahibi onu çalışma alanından oluşturur: isim, kapsamlar ve isteğe bağlı olarak bir IP izin listesi ve son kullanma tarihi. Düz metin oluşturulurken bir kez gösterilir.
Hangi kapsamlar var?
Okuma erişimi varsayılandır. Belirli bir nesneye — konuşmalar, müşteriler, randevular, siparişler — yazma erişimi kapsam başına verilir, böylece bir token yalnızca ne için yapıldıysa ona ulaşır.
IP izin listesi ne yapar?
Token'ı en fazla 20 belirli IP adresiyle sınırlar. Boş bırakırsanız token sırrın kullanıldığı her yerden çalışır; belirlerseniz diğer adreslerden gelen istekler reddedilir.
Bir token ne kadar sürebilir?
En fazla 365 gün. Bundan sonra, ya da belirlediğiniz tarihte, kimlik doğrulamayı durdurur ve değiştirilmesi gerekir.
API referansı nerede?
REST API, bir token'ın kapsamlarının ulaşabildiği uç noktaları kapsayacak şekilde /docs adresinde OpenAPI olarak belgelenir.