Mokapen API belgeleri

Organizasyonlar

Çoğu Mokapen uç noktası tek bir kuruluş kapsamına alınmıştır. Kuruluş bağlamı hem URL'de hem de erişim belirtecinde tanımlanır.

URL'deki kuruluş kimliği

Varlıklardaki uç noktalar şu modeli izler:

GET /api/v1/{org_id}/contacts
GET /api/v1/{org_id}/tasks
POST /api/v1/{org_id}/store_contact
{org_id}'yi kuruluşunuzun sayısal kimliğiyle değiştirin. Bazı entegrasyonlar şifrelenmiş bir kuruluş tanımlayıcısı kullanabilir; API, desteklendiği durumlarda her iki biçimi de kabul eder.

Belirteçteki organizasyon kısıtlaması

Geliştirici uygulamaları için verilen belirteçler, bir organization_id içerir (belirteç kaydına kaydedilir ve OAuth yanıtında bulunur).

URL'sinde {org_id} bulunan bir uç noktayı çağırdığınızda Mokapen, belirtecin o kuruluş için yetkili olduğunu doğrular. URL'deki organizasyon belirteçteki organizasyonla eşleşmiyorsa API 403 Forbidden şeklinde yanıt verir.

  • Özel Uygulamalar — organizasyon, jeton oluşturmada otomatik olarak ayarlanır (Geliştirici kontrol panelindeki aktif organizasyona göre).
  • App public — Son kullanıcı, OAuth izni sırasında organizasyonu seçer.

Kuruluş listesi uç noktası

Kuruluşların kullanıcıya veya kimlik doğrulamalı entegrasyona erişebilmesini sağlamak için:

GET /api/v1/organizations

Premium organizasyon ve API erişimi

API kullanılabilirliği ve günlük kotalar kuruluşunuzun Mokapen planına bağlıdır. Plan başına sınırlar için API Sınırları konusuna bakın.

Yardıma mı ihtiyacınız var?