Geliştiriciler · REST API

Üzerine inşa edin
Mewayz.

Tüm çalışma alanınızda tek bir REST API - CRM, satış, faturalama, muhasebe, projeler, POS, İK ve daha fazlası. 372 uç nokta, her yerde JSON, taşıyıcı jetonla doğrulanmıştır. Aynı göz atılabilir referans, uygulama içinde şu adreste bulunur: Ayarlar → API Dokümanları.

Temel URL · app.mewayz.com/api Yetkilendirme · Hamiline ait jeton Biçim · JSON Uç noktalar · 372

Kimlik doğrulama

Her isteğin kimliği bir taşıyıcı jetonla doğrulanır. Kontrol panelinizde altında bir tane oluşturun Ayarlar → API Anahtarları — bir kez gösterilir, o zaman kopyalayın. Bir jeton, onu oluşturan kullanıcının rollerini ve izinlerini devralır ve çoğu kaynak uç noktası aynı zamanda eşleştirme modülünün planınızda etkinleştirilmesini gerektirir.

Yetkilendirme başlığı
# Her istekte jetonunuzu iletin kıvrılma https://app.mewayz.com/api/leads \ -H "Yetkilendirme: Taşıyıcı 12|aZ8f3a...d92c" \ -H "Kabul et: uygulama/json"

Programlı olarak kimlik doğrulamayı mı tercih ediyorsunuz? POST /api/giriş e-postanız ve şifrenizle aynı şekilde kullanabileceğiniz bir taşıyıcı jeton döndürür ve POST /api/yenile onu döndürür.

Hızlı başlangıç

Bir dakikadan kısa sürede bir CRM müşteri adayı oluşturun. API, üründe gördüğünüz verilerle aynı şekilde çalışır; ayrı bir senkronizasyon katmanı yoktur.

POST /api/lead/create
kıvırmak -X POST https://app.mewayz.com/api/lead/create \ -H "Yetkilendirme: Taşıyıcı 12|aZ8f3a..." \ -H "İçerik Türü: uygulama/json" \ -H "Kabul et: uygulama/json" \ -D '{ "isim": "Ada Lovelace", "e-posta": "[email protected]" }'

Hatalar ve durum kodları

Geleneksel HTTP durum kodlarını kullanıyoruz. Hata gövdeleri insan tarafından okunabilen bir mesaj doğrudan yüzeye çıkabilirsiniz.

200Tamam — istek başarılı oldu
201Oluşturuldu — kaynak oluşturuldu
401Yetkisiz — eksik veya geçersiz jeton
422İşlenemez — doğrulama başarısız oldu
429Çok fazla istek var; hız sınırına ulaştınız
500Sunucu hatası - halledeceğiz durum

Oran sınırları

Platformun herkes için hızlı kalmasını sağlamak amacıyla API trafiği hız sınırlıdır. Limiti aşarsanız, bir HTTP429 yanıt - geri çekilin ve yeniden deneyin. Yeniden Dene-Sonra başlık size ne zaman devam edebileceğinizi söyler.

Kimlik doğrulama ve oturum /api/giriş

Oturum açın, jetonunuzu yenileyin veya iptal edin, oturum açmış kullanıcıyı getirin, profili düzenleyin ve personel/müşteri/satıcı kullanıcı listelerini okuyun. (11 uç nokta)

POST/api/şifreyi değiştir
AL/api/istemci-kullanıcı
SİL/api/hesabı sil
POST/api/düzenleme-profili
POST/api/giriş
POST/api/çıkış
POST/api/yenile
AL/api/personel-kullanıcı
POST/api/upload-photos
AL/api/kullanıcı
AL/api/satıcı-kullanıcı

API anahtarları /api/v1/ayarlar/api-anahtarları

Kişisel erişim belirteçlerinizi (Ayarlar → API Anahtarları altında oluşturduğunuz anahtarların aynısı) listeleyin, oluşturun ve iptal edin. (3 uç nokta)

AL/api/v1/ayarlar/api-anahtarları
POST/api/v1/ayarlar/api-anahtarları
SİL/api/v1/settings/api-keys/{id}

CRM — potansiyel müşteriler, anlaşmalar ve satış hattı /api/olası müşteriler

Potansiyel müşteriler, anlaşmalar, işlem hatları, aşamalar, etiketler ve kaynakların yanı sıra bunların görevleri, çağrıları, dosyaları, notları ve ürünleriyle ilgili tam CRUD. (79 uç nokta)

SİL/api/anlaşma-call/delete/{call_id}
POST/api/anlaşma-çağrısı/mağaza
POST/api/anlaşma-call/update/{call_id}
POST/api/anlaşma-istemcisi/mağaza/{anlaşma_id}
SİL/api/anlaşma-client/{deal_id}/delete/{client_id}
POST/api/anlaşma-tartışma/store/{anlaşma_id}
POST/api/anlaşma-e-postası/mağaza/{anlaşma_id}
POST/api/anlaşma-dosyası/mağaza/{anlaşma_id}
SİL/api/anlaşma-dosyası/{anlaşma_id}/delete/{dosya_id}
POST/api/anlaşma-kaynağı/mağaza/{anlaşma_id}
SİL/api/anlaşma-kaynak/{anlaşma_id}/delete/{kaynak_id}
POST/api/anlaşma aşaması/oluştur
SİL/api/anlaşma aşaması/delete/{id}
POST/api/anlaşma aşaması/update/{id}
AL/api/anlaşma aşamaları
POST/api/anlaşma-görevi/oluştur
SİL/api/anlaşma-görevi/delete/{id}
POST/api/anlaşma-görevi/update/{id}
POST/api/anlaşma-kullanıcısı/mağaza/{anlaşma_id}
SİL/api/deal-user/{deal_id}/delete/{user_id}
POST/api/anlaşma/add-label/{id}
POST/api/anlaşma/atama-ürünleri/{anlaşma_id}
POST/api/anlaşma/oluştur
SİL/api/anlaşma/delete/{id}
AL/api/anlaşma/gösteri/{id}
POST/api/anlaşma/güncelleme/{id}
SİL/api/anlaşma/{deal_id}/products/{product_id}
AL/api/fırsatlar
POST/api/etiket/oluştur
SİL/api/label/delete/{id}
POST/api/label/update/{id}
AL/api/etiketler
SİL/api/lead-call/delete/{call_id}
POST/api/olası müşteri çağrısı/mağaza
POST/api/lead-call/update/{call_id}
POST/api/lead-discussion/store/{lead_id}
POST/api/lead-email/store/{lead_id}
POST/api/lead-file/store/{lead_id}
SİL/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
SİL/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
SİL/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
AL/api/lead-stages
POST/api/lead-task/create
SİL/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
SİL/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/add-label/{id}
POST/api/lead/atama-ürünleri/{lead_id}
POST/api/lead/anlaşmaya-dönüştürme/{id}
POST/api/lead/oluştur
SİL/api/lead/delete/{id}
AL/api/lead/get-request-data
AL/api/lead/get-users
POST/api/olasılık/ana sayfa
POST/api/lead/lead-create-update
POST/api/lead/lead-delete
POST/api/olasılık/olasılık-ayrıntılar
POST/api/lead/lead-stage-create-update
POST/api/lead/lead-stage-update
POST/api/lead/lead-stages
POST/api/lead/leadboard
POST/api/lead/pipeline-oluşturma-güncelleme
AL/api/lead/boru hatları
AL/api/lead/show/{id}
POST/api/lead/update/{id}
SİL/api/lead/{lead_id}/products/{product_id}
AL/api/olası müşteriler
POST/api/boru hattı/oluştur
SİL/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
AL/api/boru hatları
POST/api/kaynak/oluştur
SİL/api/kaynak/delete/{id}
POST/api/kaynak/güncelleme/{id}
AL/api/kaynaklar

Satış /api/satışlar/satış-siparişleri

Fırsatlar, teklifler, toplantılar, satış siparişleri ve depo aramaları. (23 uç nokta)

AL/api/satış/RequestData
POST/api/satışlar/depo-ürünlerini-al
AL/api/satış/ana sayfa
SİL/api/satış/toplantı/destroy/{id}
POST/api/satış/toplantı/mağaza
POST/api/satış/toplantı/güncelleme/{kimlik}
AL/api/satış/toplantılar
AL/api/satışlar/fırsatlar
SİL/api/satış/fırsatlar/delete/{id}
POST/api/satış/fırsatlar/güncelleme/{id}
POST/api/satış/fırsat/mağaza
POST/api/satışlar/ebeveyn-kayıtları
AL/api/satışlar/teklifler
SİL/api/sales/quotes/destroy/{id}
POST/api/satışlar/teklifler/mağaza
POST/api/sales/quotes/update/{id}
AL/api/sales/quotes/{id}
SİL/api/satış/satış-siparişi/delete/{id}
POST/api/satış/satış-siparişi/mağaza
POST/api/satış/satış-siparişi/güncelleme/{id}
AL/api/satışlar/satış-siparişleri
AL/api/satış/satış-siparişleri/{id}
AL/api/satışlar/depolar

Satış teklifleri /api/satış-teklifi

Teklifleri tasarlayın, gönderin, kabul edin/reddedin ve bunları faturalara dönüştürün. (9 uç nokta)

AL/api/satış-teklifi
POST/api/satış-teklifi/kabul/{teklif_id}
POST/api/satış-teklifi/faturaya-dönüştürme/{teklif_id}
POST/api/satış-teklifi/oluştur
SİL/api/satış-teklifi/delete/{teklif_id}
POST/api/satış-teklifi/reject/{teklif_id}
POST/api/satış-teklifi/sent/{teklif_id}
AL/api/satış-teklifi/show/{teklif_id}
POST/api/satış-teklifi/update/{teklif_id}

Satış faturaları /api/satış-faturası

Satış faturalarını listeleyin, oluşturun, güncelleyin, silin ve deftere nakledin. (6 uç nokta)

AL/api/satış-faturası
POST/api/satış-fatura/oluştur
SİL/api/satış-faturası/delete/{invoice_id}
POST/api/satış-faturası/post/{invoice_id}
AL/api/satış-fatura/show/{invoice_id}
POST/api/satış-faturası/güncelleme/{invoice_id}

Satış faturası iadeleri /api/satış-fatura-iade

Satış faturası iadelerini oluşturun, onaylayın ve tamamlayın. (6 uç nokta)

AL/api/satış-fatura-iade
POST/api/satış-fatura-iade/onaylama/{return_id}
POST/api/sales-invoice-return/complete/{return_id}
POST/api/satış-fatura-iade/oluştur
SİL/api/satış-fatura-iade/delete/{return_id}
AL/api/satış-fatura-iade/gösteri/{return_id}

Fatura satın alma /api/satın alma-faturası

Satın alma faturalarını listeleyin, oluşturun, güncelleyin, silin ve gönderin. (6 uç nokta)

AL/api/satın alma-faturası
POST/api/satın alma-faturası/oluştur
SİL/api/satın alma-faturası/delete/{invoice_id}
POST/api/satın alma-faturası/post/{invoice_id}
AL/api/satın alma-faturası/show/{invoice_id}
POST/api/satın alma-faturası/güncelleme/{invoice_id}

Satın alma iadeleri /api/satın alma-iade

Satın alma iadelerini oluşturun, onaylayın ve tamamlayın. (6 uç nokta)

AL/api/satın alma-iade
POST/api/purchase-return/approve/{return_id}
POST/api/purchase-return/complete/{return_id}
POST/api/satın alma-iade/oluştur
SİL/api/purchase-return/delete/{return_id}
AL/api/purchase-return/show/{return_id}

Muhasebe /api/hesap planı

Müşteriler, satıcılar, banka hesapları, hesap planı, gelirler, giderler, ödemeler, alacak/borç dekontları ve transferler. (37 uç nokta)

AL/api/hesap türleri
AL/api/banka hesapları
POST/api/banka-hesapları/oluştur
SİL/api/bank-accounts/delete/{id}
POST/api/bank-accounts/update/{id}
AL/api/banka-işlemleri
AL/api/banka-transferleri
AL/api/hesap planı
AL/api/kredi notları
AL/api/müşteri ödemeleri
AL/api/müşteriler
POST/api/müşteriler/oluştur
SİL/api/müşteriler/delete/{id}
POST/api/müşteriler/update/{id}
AL/api/borç-notları
AL/api/gider kategorileri
AL/api/giderler
POST/api/giderler/approve/{id}
POST/api/giderler/oluştur
SİL/api/giderler/delete/{id}
POST/api/giderler/post/{id}
POST/api/giderler/güncelleme/{id}
AL/api/get-istemciler
AL/api/get-vendors
AL/api/gl-hesapları
AL/api/gelir kategorileri
AL/api/gelirler
POST/api/gelirler/approve/{id}
POST/api/gelirler/oluştur
SİL/api/gelirler/delete/{id}
POST/api/gelirler/post/{id}
POST/api/gelirler/güncelleme/{id}
AL/api/satıcı-ödemeler
AL/api/satıcılar
POST/api/satıcılar/oluştur
SİL/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Ürünler ve hizmetler /api/ürünler

Ürünler, kategoriler, vergiler, birimler ve stok. (20 uç nokta)

AL/api/ürün-hizmet/öğeler
POST/api/ürün-stok/ekle
AL/api/ürün-stokları
AL/api/ürün/kategori
POST/api/ürün/kategori/oluştur
SİL/api/ürün/kategori/delete/{id}
POST/api/ürün/kategori/güncelleme/{id}
POST/api/ürün/oluştur
SİL/api/ürün/delete/{id}
AL/api/ürün/detay/{kimlik}
POST/api/ürün/güncelleme/{id}
AL/api/ürünler
AL/api/vergi
POST/api/vergi/oluştur
SİL/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/birim/oluştur
SİL/api/unit/delete/{id}
POST/api/unit/update/{id}
AL/api/birimler

Depo ve envanter /api/depo

Depolar ve stok transferleri. (9 uç nokta)

AL/api/aktarım
POST/api/aktarım/oluştur
SİL/api/transfer/delete/{transfer_id}
AL/api/transfer/request-data
AL/api/depo
POST/api/depo/oluştur
SİL/api/warehouse/delete/{warehouse_id}
AL/api/depo/ürün/{depo_id}
POST/api/warehouse/update/{warehouse_id}

Projeler, görevler ve hatalar /api/projeler

Projeler, kilometre taşları, görev panoları, görevler, alt görevler, hatalar ve raporlar. (45 uç nokta)

AL/api/hata-durum-listesi
AL/api/get-projeleri
POST/api/proje/bug-stage/create
SİL/api/project/bug-stage/delete/{id}
POST/api/proje/hata aşaması/sipariş
POST/api/project/bug-stage/update/{id}
AL/api/proje/hata aşamaları
POST/api/project/bug/create/{project_id}
AL/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
SİL/api/proje/bug/{id}/comment/delete
AL/api/proje/bug/{proje_kimliği}
SİL/api/proje/istemci/delete/{id}
POST/api/proje/istemci/davet
AL/api/proje/istemciler
SİL/api/proje/delete/{id}
POST/api/proje/dosya/oluştur
SİL/api/proje/dosya/delete/{id}
SİL/api/proje/üye/delete/{id}
POST/api/proje/kilometre taşı/oluştur
SİL/api/proje/kilometre taşı/delete/{id}
POST/api/proje/kilometre taşı/güncelleme/{id}
AL/api/proje/kilometre taşları
AL/api/proje/rapor/{id}
AL/api/proje/raporlar
AL/api/proje/göster/{id}
POST/api/proje/görev aşaması/oluştur
SİL/api/project/task-stage/delete/{id}
POST/api/proje/görev aşaması/sipariş
POST/api/project/task-stage/update/{id}
AL/api/proje/görev aşamaları
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
SİL/api/proje/görev/yorum/delete/{yorum_kimliği}
AL/api/proje/görev/göster/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/proje/güncelleme/{id}
AL/api/proje/{id}/görev panosu
POST/api/proje/{id}/task/create
POST/api/proje/{id}/task/update/{task_id}
SİL/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
SİL/api/project/{proje_id}/task/delete/{task_id}
AL/api/projeler
POST/api/projeler/oluştur

Satış noktası /api/konum

POS siparişleri ve sipariş detayı. (2 uç nokta)

AL/api/konum
AL/api/pos/show/{id}

Destek masası /api/destek-bilet/biletler

Biletler ve yanıtlar, SSS'ler ve bilgi tabanı makaleleri. (16 uç nokta)

POST/api/support-ticket/faq/delete/{faq_id}
POST/api/support-ticket/faq/update/{faq_id}
AL/api/destek-bilet/faqs
POST/api/destek-bilet/faqs/mağaza
AL/api/support-ticket/get-request-data
AL/api/destek-bilet/anasayfa
POST/api/support-ticket/knowledge/delete/{knowledge_id}
POST/api/destek-bilet/bilgi/mağaza
POST/api/support-ticket/knowledge/update/{knowledge_id}
AL/api/destek-bilet/bilgiler
POST/api/support-ticket/ticket/add-reply/{ticket_id}
POST/api/support-ticket/ticket/delete/{ticket_id}
POST/api/support-ticket/ticket/note/store/{ticket_id}
POST/api/destek-bilet/bilet/mağaza
POST/api/support-ticket/ticket/update/{ticket_id}
AL/api/destek-bilet/biletler

Görevli /api/taskly/projeler

Hafif proje modülü için görev gerektiren projeler ve görevler. (18 uç nokta)

AL/api/görevli/ev
POST/api/taskly/proje-etkinliği
POST/api/taskly/proje-oluşturma-güncelleme
POST/api/taskly/proje-delete
POST/api/taskly/proje-detayları
SİL/api/taskly/proje-dosyası-delete/{id}
POST/api/taskly/proje-dosyası-yükleme
POST/api/taskly/proje listesi
POST/api/taskly/proje-durum-güncellemesi
AL/api/taskly/projeler
AL/api/taskly/projeler/{proje}/tasks
POST/api/taskly/task-create-update
POST/api/taskly/task-delete
POST/api/taskly/görev-detayları
POST/api/taskly/görev listesi
POST/api/taskly/task-stage-update
POST/api/taskly/görev panosu
AL/api/taskly/kullanıcılar

Zaman takibi /api/add-izleyici

Zaman izleyicilerini başlatın ve durdurun. (3 uç nokta)

POST/api/add-izleyici
POST/api/stop-izleyici
POST/api/tracker-giriş

Kullanıcılar ve roller /api/kullanıcılar

Çalışma alanı kullanıcılarını yönetin ve rolleri okuyun. (8 uç nokta)

AL/api/roller
SİL/api/kullanıcı/delete/{id}
POST/api/user/reset-password/{id}
POST/api/kullanıcı/mağaza
POST/api/kullanıcı/güncelleme/{id}
KOY/api/user/verify/{id}
AL/api/kullanıcılar
AL/api/kullanıcılar/log

İK ve bordro /api/çalışanlar

Çalışanlar, katılım, izinler, maaş bordrosu ve ayrıca tam İK kayıtları (şubeler, departmanlar, tatiller, ödüller ve daha fazlası). (44 uç nokta)

AL/api/teşekkürler
AL/api/duyurular
POST/api/katılım/oluştur
SİL/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
AL/api/katılımlar
AL/api/ödüller
AL/api/şubeler
AL/api/şikayetler
AL/api/departmanlar
AL/api/tanımlamalar
AL/api/belge türleri
AL/api/çalışan-transferleri
POST/api/çalışan/oluştur
SİL/api/çalışan/delete/{id}
AL/api/çalışan/gösteri/{id}
POST/api/çalışan/güncelleme/{id}
AL/api/çalışanlar
AL/api/olaylar
AL/api/tatiller
AL/api/hrm-belgeleri
POST/api/hrm/devam-geçmişi
POST/api/hrm/giriş-çıkış saati
POST/api/hrm/olaylar
AL/api/hrm/get-leaves
AL/api/hrm/get-leaves-types
AL/api/hrm/tatil listesi
AL/api/hrm/ev
POST/api/hrm/izin-isteği
POST/api/leave-application/create
SİL/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
AL/api/ayrılma-uygulamaları
AL/api/bakiyeleri bırak
AL/api/izin türleri
AL/api/maaş bordroları
AL/api/payrolls/{payroll_id}
AL/api/payslip/{payroll_entry_id}
AL/api/promosyonlar
AL/api/istifalar
AL/api/vardiyalar
AL/api/sonlandırmalar
AL/api/uyarılar

Üçüncü taraf API (v1) /api/v1/müşteriler

Müşteriler ve faturalar gibi Zapier gibi kod gerektirmeyen araçlar için oluşturulmuş kararlı, sürümlü bir dilim. (7 uç nokta)

AL/api/v1/müşteriler
POST/api/v1/müşteriler
AL/api/v1/müşteriler/{id}
KOY/api/v1/müşteriler/{id}
AL/api/v1/faturalar
POST/api/v1/faturalar
AL/api/v1/faturalar/{id}

Genel uç noktalar /api/genel/planlar

Kimliği doğrulanmamış yardımcılar: genel plan kataloğu ve yerleştirilebilir müşteri adayı yakalama widget'ı ve iş ortağı rozeti. (4 uç nokta)

AL/api/rozet/{token}
AL/api/genel/planlar
POST/api/widget/lead
AL/api/widget/{token}

Beyaz etiketli platform /api/wl/planlar

Faturalandırma ve Stripe Connect (belirteç kimlik doğrulamalı) için beyaz etiketli örnekler tarafından kullanılan sunucudan sunucuya uç noktalar. (6 uç nokta)

POST/api/wl/ödeme
POST/api/wl/connect/yerleşik
AL/api/wl/connect/durum
AL/api/wl/planlar
POST/api/wl/subscription/{stripe_subscription_id}/cancel
POST/api/wl/webhook-geri arama

Entegrasyon uç noktaları /api/microsofttodo

Bağlı entegrasyonlar için yardımcı uç noktalar (Microsoft To Do, Vonage SMS, Facebook gönderileri). (3 uç nokta)

AL/api/facebookpost
AL/api/microsofttodo
AL/api/vonagesms

Daha fazla uç nokta

Ek kayıtlı uç noktalar. (1 uç nokta)

AL/api/agents/{agent}/outstanding-commissions