Mokapen API belgeleri

Genel Bakış

Mokapen API'leri REST'tir. Aksi belirtilmediği sürece, her istek geçerli bir Authorization: Bearer başlığını içermelidir.

Temel URL: https://mokapen.com/api

API sürümü öneki: v1 (örnek: /api/v1/{org_id}/contacts).

Adım 1 — Bir uygulama oluşturun

Mokapen'e giriş yapın, kuruluşunuzu açın ve Hesap → Geliştirici → Uygulamalarım seçeneğine gidin. Buradan mevcut uygulamaları görebilir veya yeni bir tane oluşturabilirsiniz.

Mokapen iki tür uygulamayı desteklemektedir:

• App public — birden fazla Mokapen kullanıcısı tarafından kullanılan entegrasyonlar için tasarlanmıştır. OAuth 2.0 yetkilendirme kodu akışını kullanın. Kullanıcılar uygulamanızı yetkilendirir ve hangi kuruluşa erişim izni vereceğini seçer.
• Özel uygulamalar — kuruluşunuz dahilinde dahili otomasyon için tasarlanmıştır. client_credentials iznini kullanın. Belirteçler, son kullanıcıya OAuth yönlendirmeleri olmadan Geliştirici kontrol panelinden oluşturulur.

Başvuru gereksinimleri

Adım 2 — API kapsamlarını seçin

Uygulama verilerini doldurduktan sonra gerekli kapsamları (izinler) seçmek için Devam öğesine tıklayın ve ardından uygulamayı kaydedin.

Yetkilendirmede (genel uygulama) yalnızca kurulum sırasında etkinleştirilen kapsamlar talep edilebilir veya belirteçlere (özel uygulama) dahil edilebilir.

Adım 3 — Etkinleştirme ve kimlik bilgileri

özel uygulamalar oluşturulduktan hemen sonra etkinleştirilir. Kuruluş sahipleri ve yöneticileri, bunları istedikleri zaman uygulama sayfasından devre dışı bırakabilir veya yeniden etkinleştirebilir.

public başvuruları Onay Bekleniyor olarak başlar. Mokapen, uygulamayı etkinleştirmeden önce gerekli kapsamları inceler. Durum Active olduğunda, client_id ve client_secret almak için Credentials sekmesini açın ve OAuth yetkilendirme kodu akışını başlatın.

Halihazırda etkin olan genel bir uygulamanın kapsamlarını değiştirirseniz, onay bekleme durumuna geri döner ve mevcut belirteçler iptal edilir.

Kimlik bilgilerinizi güvenli bir şekilde saklayın. İstemci sırrını asla istemci tarafı kodunda veya genel depolarda açığa çıkarmayın.

Sonraki adımlar

• Uygulama herkese açık → Kimlik doğrulama kılavuzunu (OAuth yetkilendirme kodu) izleyin.
• Özel uygulamalar → Kimlik Bilgileri sekmesinden bir belirteç oluşturun ve ardından Özel uygulama belirteçleri'ye bakın.
• API Referansı'deki uç noktaları keşfedin.