API Mewayz Eklentisi
Sorunsuz proje ve görev yönetimi için Mewayz'nin API entegrasyonunun gücünü keşfedin. Kolayca genişletin ve özelleştirin. Şimdi dene!
Giriş
API Docs Generator, Mewayz platformu için eksiksiz API belgeleri sağlayan güçlü bir Eklentidir. Bu Eklenti, geliştiricilerin ve teknik ekiplerin uç noktalar, başlıklar, parametreler ve yanıt örnekleri dahil olmak üzere ayrıntılı API bilgilerine erişmesine yardımcı olur. Belgeler, platformun 14 ana modülünü kapsıyor ve kullanıcıların Postman gibi araçları kullanarak özel uygulamalar oluşturmasına, harici sistemleri entegre etmesine veya API'leri manuel olarak test etmesine olanak tanıyor.
Bu modül nasıl etkinleştirilir
API Eklentisini Kurmak için şu bağlantıyı takip edebilirsiniz: Eklentiyi Kur.
API Eklentisi nasıl kullanılır?
API Dokümanları Oluşturun
Bu Eklentiyi satın alıp yükledikten sonra kontrol panelinizin kenar çubuğuna gidin ve API Dokümanları Eklentisini arayın.
API belgelerine erişmek için ana kontrol panelinizden API Dokümanları bölümüne gidin. Dokümantasyon şu şekilde düzenlenir: 14 modülEntegrasyon projeniz için ihtiyaç duyduğunuz belirli API'leri bulmanızı kolaylaştırır.
Bu bölümde API'lerin etkili bir şekilde nasıl kullanılacağını açıklayan genel bir giriş yer almaktadır. Bu genel bakış, tüm API uç noktalarında geçerli olan kimlik doğrulama gereksinimlerini, ortak başlıkları ve temel kullanım yönergelerini kapsar.
Her modül, eksiksiz teknik ayrıntılarla birlikte güçlü API listeleri içerir. Her API uç noktası için API adını, tam uç nokta URL'sini, kimlik doğrulama ve veri biçimi için gerekli başlıkları, veri türleri ve doğrulama kurallarıyla birlikte giriş parametrelerini, beklenen veri yapısını gösteren örnek başarı yanıtlarını ve yaygın hata kodları ve mesajlarıyla birlikte örnek hata yanıtlarını bulacaksınız.
Giriş Yönetimi
Bu kapsamlı API belgeleri, Mewayz özelliklerinin gücünden yararlanmaya açılan kapınızdır; çalışmalarınızı kolaylaştırmanıza, verimliliği artırmanıza ve projelerinizi bir sonraki seviyeye taşımanıza olanak tanır.
Bu API belgeleri, uygulamalarında Mewayz'nin yeteneklerinden yararlanmak isteyen hem deneyimli hem de yeni geliştiriciler için bir kaynaktır. İşte bulmayı bekleyebileceğiniz şeyler.
Ürünün içindeki tam, etkileşimli referansa aşağıdan göz atabilirsiniz. Ayarlar → API Dokümanları.
Uç noktalar bölümü, verileri almak için GET'i, yeni veriler oluşturmak için POST'u, mevcut verileri güncellemek için POST'u ve verileri kaldırmak için DELETE'i kapsar. Verileri almak için GET, yeni veriler oluşturmak için POST, mevcut verileri güncellemek için POST ve verileri kaldırmak için DELETE gibi HTTP yöntemlerini kullanabilirsiniz.
İstek parametreleri, API isteklerinizin davranışını özelleştirmek ve API ile etkileşimde bulunurken daha spesifik ayrıntılar sağlamak için kullanılır. Mewayz için aşağıdaki istek parametresi türlerine sahip olabilirsiniz: Bilgi alırken verileri filtrelemek veya sıralamak için Sorgu Parametreleri, kimlik doğrulama için İstek Başlıkları ve istekle ilgili ek meta veriler ve oluşturulacak veya güncellenecek JSON verilerini içeren İstek Gövdesi.
Mewayz API'si genellikle JSON formatındaki verilerle yanıt verir. Yanıt genellikle isteğin sonucunu gösteren bir HTTP durum kodu içerir ve gerçek veriler, yanıtın içinde yer alır. “veri” alan.
Kimlik Doğrulama Yönetimi
Kimlik Doğrulama API'leri, oturumların sürdürülmesi için gerekli oturum açma işlevlerini, belirteç yenileme yeteneklerini ve güvenli son kullanıcı oturumları için oturum kapatma prosedürlerini sağlar.
Oturum açma uç noktası POST /api/login ile başlıklar gerekir “Kabul et”: “uygulama/json” ve e-posta gibi parametreler dahil “[email protected]” ve **“john****”** gibi şifre.
Hata yanıtları 422 İşlenemez İçerik döndürüyor: “başarı”: yanlış, “mesaj”: “Doğrulama Doğrulama bir hata olduğunda.
Hata yanıtları 400 Yetkisiz değerini döndürüyor “başarı”: yanlış, “mesaj”: “Sağlanan” kimlik bilgileri geçersiz olduğunda.
Başarılı giriş yanıtları 200 OK değerini döndürür “başarı”: doğru ve belirteç ve türü içeren yetkilendirme “taşıyıcı” sonraki API çağrıları için.
Kimlik doğrulama yenileme uç noktası POST /api/refresh, oturum yönetimi için Bearer jetonlu yetkilendirme başlıklarını kullanır.
Başarılı yenileme yanıtları, 200 Tamam ile birlikte dahil olmak üzere ayrıntılı kullanıcı bilgilerini döndürür. “başarı”: doğru ve kullanıcı ayrıntıları, kimlik, ad, e-posta, mobil_no, şunu yazın: “şirket”, avatar: “URL”, dil: “tr” ve jeton.
Kullanıcı Yönetimi
- Kullanıcı yönetimi, rol yönetimi ve profil için Kullanıcı API'leri
operasyonlar.
Depo Yönetimi
- Ambar yapılandırması ve ambar transferleri için ambar API'leri
yönetim.
Ürün ve Hizmet Yönetimi
- Ürün ve Hizmet bölümü API'leri ürün kategorilerini, vergileri,
Depo entegrasyonu ile ölçüm birimleri, ürünler ve stok yönetimi.
Satın Alma Fatura Yönetimi
- Satın Alma Faturası Listesi için Satın Alma Faturası API'leri, Oluşturma, Detaylandırma,
Güncelleme, Silme, Fatura Postası yönetimi.
Satın Alma İade Yönetimi
- Satın Alma İade Listesi, Oluşturma, İade Ayrıntısını yönetmeye yönelik API'ler,
Sil, Onayla, İşlemi tamamla.
Satış Teklif Yönetimi
- Teklif yönetimi ve dönüşümü için Satış Teklifi API'leri
süreçler.
Satış Fatura Yönetimi
- Satış Faturası API'leri fatura listesi, oluşturma, Güncelleme, Silme,
Fatura Postası yönetimi.
Satış Faturası İade Yönetimi
- Satış Fatura İade Listesini yönetmek, Oluşturmak, Detaylandırmak, Silmek için API'ler,
Onaylayın ve Tamamlayın.
Hesap Yönetimi
- Hesap bölümü API'leri Müşterileri, Satıcıları,
- Hesap modülü, basit bilgileri almak için hızlı liste API'lerini içerir.
Banka Hesapları, Hesap Planı, Gelirler, Giderler, Kredi Dekontları, Borç Dekontları, Satıcı Ödemeleri, Müşteri Ödemeleri, Banka İşlemleri, Banka Transferleri kayıtları. Gerektiğinde kayıtları listeleme, yeni giriş oluşturma, ayrıntıları görüntüleme, bilgileri güncelleme, kayıtları silme gibi işlemleri gerçekleştirebilirsiniz.
açılır seçimler ve hızlı referanslar için gelir ve gider kategorilerinin yanı sıra müşteri ve satıcı listeleri, Gl Hesap Listesi.
Proje Yönetimi
- Proje bölümü API'leri projeleri, görevleri, hataları, kilometre taşlarını,
dosyalar ve ilgili aşamalar ve iş akışlarıyla birlikte çeşitli raporlar.
POS Yönetimi
- POS API'leri, sipariş yönetimi de dahil olmak üzere satış noktası operasyonlarını yönetir
ve Sipariş Ayrıntıları.
CRM Yönetimi
- CRM bölümü API'leri Boru Hattı yönetimini, müşteri adayı ve anlaşma aşamalarını kapsar.
etiketler, kaynaklar ve eksiksiz Potansiyel Müşteri yönetimi ve Anlaşma yönetimi. Hem potansiyel müşteriler hem de fırsatlarla ilişkili görevleri, kullanıcıları, ürünleri, kaynakları, e-postaları, tartışmaları, dosyaları ve çağrıları yönetebilirsiniz.
İKY Yönetimi
- HRM API'leri çalışan yönetimini, organizasyon yapısını,
katılım takibi, izin yönetimi, bordro işlemleri ve Ödüller, Terfiler, İstifalar, Fesihler, Uyarılar, Şikayetler, Çalışan Transferleri, tatiller, etkinlikler, belgeler, Duyurular ve Teşekkür dahil olmak üzere çeşitli İK kayıtları.
Belgelerdeki her API uç noktası, doğrudan geliştirme ortamınızda veya test araçlarınızda kopyalayıp kullanabileceğiniz pratik örnekler içerir. Yanıt örnekleri hem başarılı işlemleri hem de yaygın hata senaryolarını göstererek uygulamalarınızda doğru hata yönetimini uygulamanıza yardımcı olur.
Modüller Wise API'leri Listesi:
- Kimlik doğrulama:
- Giriş yapmak
- Jeton Yenileme
- Oturumu kapat
- Kullanıcı:
- Kullanıcı: Listele, Oluştur, Güncelle, Sil,
- Rol: Liste
- Kullanıcı Günlüğü: Liste
- Personel Kullanıcılar: Liste
- İstemci Kullanıcılar: Liste
- Satıcı Kullanıcılar: Liste
- Depo:
Profil Güncelleme, Şifre Güncelleme, Şifre Sıfırlama, Doğrulama
- Depo: Listele, Oluştur, Detaylandır, Güncelle,
- Aktarım: Listele, Talep Verisi Oluştur,
- Ürün ve Hizmet :
Sil
Oluştur, Sil
- Ürün Kategorisi : Listele, Oluştur, Güncelle,
- Vergi : Listele, Oluştur, Güncelle, Sil
- Birim: Listele, Oluştur, Güncelle, Sil
- Ürün: Listele, Oluştur, Detaylandır, Güncelle,
- Ürün Stoku : Listele, Ekle
- Depo Ürünü : Liste
- Satın Alma Faturası:
Sil
Sil
- Fatura: Listele, Oluştur, Detaylandır, Güncelle,
- Satın Alma İadesi:
Sil, Gönder
- Dönüş : Listele, Oluştur, Detaylandır, Sil,
- Satış Teklifi :
Onayla, Tamamla
- Teklif: Listele, Oluştur, Detaylandır, Güncelle,
- Satış Faturası :
Sil, Gönder, Kabul Et, Reddet, Faturaya Dönüştür
- Fatura: Listele, Oluştur, Detaylandır, Güncelle,
- Satış Fatura İadesi :
Sil, Gönder
- Dönüş : Listele, Oluştur, Detaylandır, Sil,
- Hesap:
Onayla, Tamamla
- Müşterileri Alın: Basit müşteri listesi
- Satıcıları Alın: Basit satıcı listesi
- Müşteri: Listele, Oluştur, Güncelle, Sil
- Satıcı : Listele, Oluştur, Güncelle, Sil
- Gl Hesabı: Liste
- Banka Hesabı : Listele, Oluştur, Güncelle, Sil
- Gelir Kategorileri : Liste
- Gelir: Listele, Oluştur, Güncelle, Sil,
- Gider Kategorileri : Liste
- Gider: Listele, Oluştur, Güncelle, Sil,
- Hesap Türleri : Liste
- Hesap Planı : Liste
- Banka İşlemi : Liste
- Banka Havalesi: Liste
- Satıcı Ödemeleri: Liste
- Müşteri Ödemeleri: Liste
- Kredi Notu : Liste
- Borç Dekontu : Liste
- Proje:
Onayla, Gönder
Onayla, Gönder
- Proje: Listele, Oluştur, Detaylandır, Güncelle,
- Proje Üyesi : Sil
- Proje Müşterisi: Listele, Davet Et, Sil
- Projenin Kilometre Taşı: Listele, Oluştur, Güncelle,
- Proje Dosyası: Oluştur, Sil
- Görev: Görev Panosu, Oluştur, Detaylandır, Güncelle,
- Görev Yorumu: Oluştur, Sil
- Görev Alt Görevi: Oluştur, Güncelle
- Hata Durumu: Liste
- Hata: Listele, Oluştur, Detaylandır, Güncelle, Sil
- Hata Yorumu: Oluştur, Sil
- Proje Raporu: Liste, Detay
- Görev Aşaması: Listele, Sırala, Oluştur, Güncelle,
- Hata Aşaması: Listele, Sırala, Oluştur, Güncelle,
- POS:
Sil
Sil
Sil
Sil
Sil
- Sipariş : Liste, Detay
- CRM:
- Boru hattı: Listele, Oluştur, Güncelle, Sil
- Liderlik Aşaması: Listele, Oluştur, Güncelle, Sil
- Anlaşma Aşaması: Listele, Oluştur, Güncelle, Sil
- Etiketler: Listele, Oluştur, Güncelle, Sil
- Kaynaklar: Listele, Oluştur, Güncelle, Sil
- Kurşun: Listele, Oluştur, Detaylandır, Güncelle,
- Liderlik Görevi: Oluştur, Güncelle, Sil
- Lider Kullanıcı: Oluştur, Sil
- Kurşun Ürün: Oluştur, Sil
- Potansiyel Müşteri Kaynağı: Oluştur, Sil
- Potansiyel Müşteri E-postası: Oluştur
- Lider Tartışma: Oluştur
- Potansiyel Müşteri Dosyası: Oluştur, Sil
- Potansiyel Müşteri Çağrısı: Oluştur, Güncelle, Sil
- Anlaşma: Listele, Oluştur, Detaylandır, Güncelle,
- Anlaşma Görevi: Oluştur, Güncelle, Sil
- Fırsat Kullanıcısı: Oluştur, Sil
- Fırsat Ürünü: Oluştur, Sil
- Fırsat Kaynağı: Oluştur, Sil
- Fırsat E-postası: Oluştur
- Anlaşma Tartışması: Oluştur
- Anlaşma Dosyası: Oluştur, Sil
- Anlaşma Müşterisi: Oluştur, Sil
- Anlaşma Çağrısı: Oluştur, Güncelle, Sil
- İnsan kaynakları yönetimi:
Sil, Etiket Ekle, Anlaşmaya Dönüştür
Etiket Sil, Ekle
- Çalışan: Listele, Oluştur, Detaylandır, Güncelle,
- Katılım: Listele, Oluştur, Güncelle, Sil
- İzin Türleri: Liste
- Başvurulardan Ayrılın: Listele, Oluştur, Güncelle,
- Bakiyeyi Bırak: Kontrol et
- Maaş bordrosu: Liste, Detay
- Maaş bordrosu: Oluştur
- Vardiyalar: Liste
- Şubeler: Liste
- Bölümler: Liste
- Tanımlar: Liste
- Belge Türleri : Liste
- Tatiller : Liste
- Ödüller: Liste
- Promosyonlar: Liste
- İstifalar: Liste
- Fesihler: Liste
- Uyarılar: Liste
- Şikayetler: Liste
- Çalışan Transferleri: Liste
- Belgeler: Liste
- Teşekkürler: Liste
- Duyurular: Liste
- Olaylar : Liste
Sil
Durumu Sil, Güncelle