Programiści · REST API

Opieraj się
Mewayz.

Jeden interfejs API REST w całym obszarze roboczym — CRM, sprzedaż, fakturowanie, księgowość, projekty, POS, HR i nie tylko. 372 punkty końcowe, wszędzie JSON, uwierzytelniane za pomocą tokena okaziciela. Ten sam odnośnik do przeglądania znajduje się w aplikacji Ustawienia → Dokumenty API.

Bazowy adres URL · app.mewayz.com/api Autoryzacja · Token okaziciela Formatuj · JSON Punkty końcowe · 372

Uwierzytelnianie

Każde żądanie jest uwierzytelniane za pomocą tokena okaziciela. Wygeneruj go w swoim panelu pod Ustawienia → Klucze API — jest wyświetlany raz, więc skopiuj go wtedy. Token dziedziczy role i uprawnienia użytkownika, który go utworzył, a większość punktów końcowych zasobów wymaga również włączenia odpowiedniego modułu w Twoim planie.

Nagłówek autoryzacji
# Przekaż swój token przy każdym żądaniu zwiń https://app.mewayz.com/api/leads \ -H „Autoryzacja: okaziciel 12|aZ8f3a...d92c” \ -H „Akceptuj: aplikacja/json”

Wolisz uwierzytelniać programowo? POST /api/login wraz z adresem e-mail i hasłem zwraca token na okaziciela, którego możesz użyć w ten sam sposób, oraz POST /api/odśwież obraca go.

Szybki start

Utwórz potencjalnego klienta CRM w mniej niż minutę. Interfejs API działa na tych samych danych, które widzisz w produkcie — nie ma osobnej warstwy synchronizacji.

POST /api/lead/create
zwijać się -X POST https://app.mewayz.com/api/lead/create \ -H „Autoryzacja: okaziciel 12|aZ8f3a…” \ -H „Typ zawartości: aplikacja/json” \ -H „Akceptuj: aplikacja/json” \ -D '{ "imię": "Ada Lovelace", "e-mail": "[email protected]" }'

Błędy i kody stanu

Używamy konwencjonalnych kodów stanu HTTP. Ciała błędów obejmują tekst czytelny dla człowieka wiadomość możesz wypłynąć bezpośrednio na powierzchnię.

200OK — żądanie powiodło się
201Utworzono — zasób został utworzony
401Nieautoryzowany — brakujący lub nieprawidłowy token
422Nieprzetworzone — weryfikacja nie powiodła się
429Zbyt wiele żądań — osiągnięto limit szybkości
500Błąd serwera — włączymy to stan

Limity stawek

Ruch API jest ograniczony szybkością, aby platforma była szybka dla wszystkich. Jeśli przekroczysz limit, otrzymasz HTTP429 odpowiedź — wycofaj się i spróbuj ponownie. The Spróbuj ponownie po nagłówek informuje, kiedy możesz wznowić.

Uwierzytelnianie i sesja /api/logowanie

Zaloguj się, odśwież lub unieważnij swój token, pobierz zalogowanego użytkownika, edytuj profil i czytaj listy pracowników / klientów / dostawców. (11 punktów końcowych)

POST/api/zmiana-hasła
DOBIERZ/api/klient-użytkownik
USUŃ/api/usuń-konto
POST/api/edytuj-profil
POST/api/logowanie
POST/api/wyloguj
POST/api/odśwież
DOBIERZ/api/użytkownik-staff
POST/api/upload-zdjęcia
DOBIERZ/api/użytkownik
DOBIERZ/api/użytkownik-dostawcy

Klucze API /api/v1/settings/api-keys

Wyświetlaj, twórz i unieważniaj swoje osobiste tokeny dostępu — te same klucze, które generujesz w Ustawieniach → Klucze API. (3 punkty końcowe)

DOBIERZ/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
USUŃ/api/v1/settings/api-keys/{id}

CRM — potencjalni klienci, oferty i rurociągi /api/potencjalni klienci

Pełny CRUD dotyczący potencjalnych klientów, transakcji, rurociągów, etapów, etykiet i źródeł, a także ich zadań, połączeń, plików, notatek i produktów. (79 punktów końcowych)

USUŃ/api/deal-call/delete/{call_id}
POST/api/deal-call/store
POST/api/deal-call/update/{call_id}
POST/api/deal-client/store/{deal_id}
USUŃ/api/deal-client/{deal_id}/delete/{client_id}
POST/api/deal-discussion/store/{deal_id}
POST/api/deal-email/store/{deal_id}
POST/api/deal-file/store/{deal_id}
USUŃ/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
USUŃ/api/deal-source/{deal_id}/delete/{source_id}
POST/api/stage-deal/create
USUŃ/api/etap-sprzedaży/delete/{id}
POST/api/stage-deal/update/{id}
DOBIERZ/api/etapy transakcji
POST/api/deal-task/create
USUŃ/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/deal-user/store/{deal_id}
USUŃ/api/deal-user/{deal_id}/delete/{user_id}
POST/api/deal/add-label/{id}
POST/api/deal/ przypisania-produktów/{deal_id}
POST/api/deal/utwórz
USUŃ/api/deal/delete/{id}
DOBIERZ/api/deal/show/{id}
POST/api/deal/update/{id}
USUŃ/api/deal/{deal_id}/products/{product_id}
DOBIERZ/api/oferty
POST/api/label/utwórz
USUŃ/api/label/delete/{id}
POST/api/label/update/{id}
DOBIERZ/api/etykiety
USUŃ/api/lead-call/delete/{call_id}
POST/api/lead-call/store
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}
USUŃ/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
USUŃ/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
USUŃ/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
DOBIERZ/api/lead-etapy
POST/api/lead-task/create
USUŃ/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
USUŃ/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/add-label/{id}
POST/api/lead/przypisać-produkty/{lead_id}
POST/api/lead/convert-to-deal/{id}
POST/api/lead/utwórz
USUŃ/api/lead/delete/{id}
DOBIERZ/api/lead/get-request-data
DOBIERZ/api/lead/get-users
POST/api/lead/home
POST/api/lead/lead-create-update
POST/api/lead/usuń-lead
POST/api/lead/lead-details
POST/api/lead/lead-stage-create-update
POST/api/lead/lead-stage-update
POST/api/lead/lead-etapy
POST/api/lead/leadboard
POST/api/lead/pipeline-create-update
DOBIERZ/api/lead/rurociągi
DOBIERZ/api/lead/show/{id}
POST/api/lead/update/{id}
USUŃ/api/lead/{lead_id}/products/{product_id}
DOBIERZ/api/potencjalni klienci
POST/api/potok/utwórz
USUŃ/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
DOBIERZ/api/potoki
POST/api/źródło/utwórz
USUŃ/api/source/delete/{id}
POST/api/source/update/{id}
DOBIERZ/api/źródła

Sprzedaż /api/sales/zamówienia-sprzedaży

Szanse, oferty, spotkania, zamówienia sprzedaży i wyszukiwania w magazynach. (23 punkty końcowe)

DOBIERZ/api/sales/RequestData
POST/api/sales/get-warehouse-products
DOBIERZ/api/sprzedaż/home
USUŃ/api/sales/meeting/destroy/{id}
POST/api/sales/meeting/store
POST/api/sales/meeting/update/{id}
DOBIERZ/api/sprzedaż/spotkania
DOBIERZ/api/sprzedaż/szanse
USUŃ/api/sales/opportunities/delete/{id}
POST/api/sales/opportunities/update/{id}
POST/api/sales/opportunity/store
POST/api/sales/parent-records
DOBIERZ/api/sprzedaż/cytaty
USUŃ/api/sales/quotes/destroy/{id}
POST/api/sales/quotes/store
POST/api/sales/quotes/update/{id}
DOBIERZ/api/sales/quotes/{id}
USUŃ/api/sales/zamówienie-sprzedaży/delete/{id}
POST/api/sales/sales-order/store
POST/api/sales/zamówienie-sprzedaży/update/{id}
DOBIERZ/api/sales/zamówienia-sprzedaży
DOBIERZ/api/sales/zamówienia-sprzedaży/{id}
DOBIERZ/api/sprzedaż/magazyn

Propozycje sprzedaży /api/propozycja-sprzedaży

Twórz, wysyłaj, akceptuj/odrzucaj propozycje i konwertuj je na faktury. (9 punktów końcowych)

DOBIERZ/api/propozycja-sprzedaży
POST/api/sales-proposal/accept/{proposal_id}
POST/api/sales-proposal/convert-to-invoice/{proposal_id}
POST/api/propozycja sprzedaży/create
USUŃ/api/sales-proposal/delete/{proposal_id}
POST/api/sales-proposal/reject/{proposal_id}
POST/api/sales-proposal/sent/{proposal_id}
DOBIERZ/api/sales-proposal/show/{proposal_id}
POST/api/sales-proposal/update/{proposal_id}

Faktury sprzedaży /api/faktura-sprzedaży

Wyświetlaj, twórz, aktualizuj, usuwaj i księguj faktury sprzedaży. (6 punktów końcowych)

DOBIERZ/api/faktura-sprzedaży
POST/api/faktura-sprzedaży/create
USUŃ/api/faktura-sprzedaży/delete/{id_faktury}
POST/api/faktura-sprzedaży/post/{id_faktury}
DOBIERZ/api/faktura-sprzedaży/show/{id_faktury}
POST/api/faktura-sprzedaży/update/{id_faktury}

Zwroty faktur sprzedaży /api/faktura-sprzedaży-return

Twórz, zatwierdzaj i kompletuj zwroty faktur sprzedaży. (6 punktów końcowych)

DOBIERZ/api/faktura-sprzedaży-return
POST/api/faktura-sprzedaży-return/approve/{return_id}
POST/api/faktura-sprzedaży-return/complete/{return_id}
POST/api/faktura-sprzedaży-return/create
USUŃ/api/faktura-sprzedaży-return/delete/{return_id}
DOBIERZ/api/faktura-sprzedaży-return/show/{return_id}

Faktury zakupowe /api/faktura-zakupu

Wyświetlaj, twórz, aktualizuj, usuwaj i księguj faktury zakupu. (6 punktów końcowych)

DOBIERZ/api/faktura-zakupu
POST/api/faktura-zakupu/create
USUŃ/api/faktura-zakupu/delete/{id_faktury}
POST/api/faktura-zakupu/post/{id_faktury}
DOBIERZ/api/faktura-zakupu/show/{id_faktury}
POST/api/faktura-zakupu/update/{id_faktury}

Zwroty zakupów /api/zwrot-zakupu

Twórz, zatwierdzaj i realizuj zwroty zakupów. (6 punktów końcowych)

DOBIERZ/api/zwrot-zakupu
POST/api/purchase-return/approve/{return_id}
POST/api/purchase-return/complete/{return_id}
POST/api/purchase-return/create
USUŃ/api/purchase-return/delete/{return_id}
DOBIERZ/api/purchase-return/show/{return_id}

Księgowość /api/plan-kont

Klienci, dostawcy, konta bankowe, plan kont, przychody, wydatki, płatności, noty kredytowe/debetowe i przelewy. (37 punktów końcowych)

DOBIERZ/api/typy-kont
DOBIERZ/api/konta-bankowe
POST/api/konta-bankowe/utwórz
USUŃ/api/konta-bankowe/delete/{id}
POST/api/bank-accounts/update/{id}
DOBIERZ/api/transakcje bankowe
DOBIERZ/api/przelewy-bankowe
DOBIERZ/api/plan-kont
DOBIERZ/api/noty-kredytowe
DOBIERZ/api/płatności-klienta
DOBIERZ/api/klienci
POST/api/customers/create
USUŃ/api/klienci/delete/{id}
POST/api/klienci/update/{id}
DOBIERZ/api/noty-debetowe
DOBIERZ/api/kategorie-wydatków
DOBIERZ/api/wydatki
POST/api/wydatki/zatwierdzenie/{id}
POST/api/wydatki/utwórz
USUŃ/api/wydatki/delete/{id}
POST/api/wydatki/post/{id}
POST/api/wydatki/update/{id}
DOBIERZ/api/get-clients
DOBIERZ/api/get-vendors
DOBIERZ/api/gl-konta
DOBIERZ/api/kategorie-przychodów
DOBIERZ/api/przychody
POST/api/revenues/approve/{id}
POST/api/revenues/utwórz
USUŃ/api/revenues/delete/{id}
POST/api/revenues/post/{id}
POST/api/revenues/update/{id}
DOBIERZ/api/vendor-payments
DOBIERZ/api/sprzedawcy
POST/api/vendors/create
USUŃ/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Produkty i usługi /api/produkty

Produkty, kategorie, podatki, jednostki i zapasy. (20 punktów końcowych)

DOBIERZ/api/product-service/items
POST/api/product-stock/add
DOBIERZ/api/produkt-stocks
DOBIERZ/api/produkt/kategoria
POST/api/produkt/kategoria/utwórz
USUŃ/api/produkt/kategoria/usuń/{id}
POST/api/produkt/kategoria/update/{id}
POST/api/produkt/utwórz
USUŃ/api/produkt/usuń/{id}
DOBIERZ/api/produkt/szczegóły/{id}
POST/api/product/update/{id}
DOBIERZ/api/produkty
DOBIERZ/api/podatek
POST/api/tax/utwórz
USUŃ/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/jednostka/utwórz
USUŃ/api/unit/delete/{id}
POST/api/unit/update/{id}
DOBIERZ/api/jednostki

Magazyn i inwentarz /api/magazyn

Magazyny i przesunięcia magazynowe. (9 punktów końcowych)

DOBIERZ/api/transfer
POST/api/transfer/utwórz
USUŃ/api/transfer/delete/{id_transferu}
DOBIERZ/api/transfer/request-data
DOBIERZ/api/magazyn
POST/api/magazyn/utwórz
USUŃ/api/warehouse/delete/{warehouse_id}
DOBIERZ/api/warehouse/product/{warehouse_id}
POST/api/warehouse/update/{warehouse_id}

Projekty, zadania i błędy /api/projekty

Projekty, kamienie milowe, tablice zadań, zadania, podzadania, błędy i raporty. (45 punktów końcowych)

DOBIERZ/api/bug-status-list
DOBIERZ/api/get-projects
POST/api/project/bug-stage/create
USUŃ/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
DOBIERZ/api/project/bug-stages
POST/api/project/bug/create/{project_id}
DOBIERZ/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
USUŃ/api/project/bug/{id}/comment/delete
DOBIERZ/api/project/bug/{project_id}
USUŃ/api/project/client/delete/{id}
POST/api/project/client/invite
DOBIERZ/api/projekt/klient
USUŃ/api/project/delete/{id}
POST/api/projekt/plik/utwórz
USUŃ/api/project/file/delete/{id}
USUŃ/api/project/member/delete/{id}
POST/api/project/milestone/create
USUŃ/api/project/milestone/delete/{id}
POST/api/project/milestone/update/{id}
DOBIERZ/api/project/kamienie milowe
DOBIERZ/api/projekt/raport/{id}
DOBIERZ/api/projekt/raporty
DOBIERZ/api/project/show/{id}
POST/api/project/etap-zadania/create
USUŃ/api/project/etap-zadania/delete/{id}
POST/api/project/etap-zadania/zamówienie
POST/api/project/etap-zadania/update/{id}
DOBIERZ/api/project/task-etapy
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
USUŃ/api/project/task/comment/delete/{comment_id}
DOBIERZ/api/project/task/show/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
DOBIERZ/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
USUŃ/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
USUŃ/api/project/{project_id}/task/delete/{task_id}
DOBIERZ/api/projekty
POST/api/projects/create

Punkt sprzedaży /api/poz

Zamówienia POS i szczegóły zamówienia. (2 punkty końcowe)

DOBIERZ/api/poz
DOBIERZ/api/pos/show/{id}

Biuro wsparcia /api/support-ticket/tickets

Zgłoszenia i odpowiedzi, często zadawane pytania i artykuły z bazy wiedzy. (16 punktów końcowych)

POST/api/support-ticket/faq/delete/{faq_id}
POST/api/support-ticket/faq/update/{faq_id}
DOBIERZ/api/support-ticket/faqs
POST/api/support-ticket/faqs/store
DOBIERZ/api/support-ticket/get-request-data
DOBIERZ/api/support-ticket/home
POST/api/support-ticket/knowledge/delete/{knowledge_id}
POST/api/support-ticket/knowledge/store
POST/api/support-ticket/knowledge/update/{knowledge_id}
DOBIERZ/api/support-ticket/knowledges
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/support-ticket/ticket/store
POST/api/support-ticket/ticket/update/{ticket_id}
DOBIERZ/api/support-ticket/tickets

Zadaniowo /api/taskly/projects

Projekty zadaniowe i zadania dla lekkiego modułu projektowego. (18 punktów końcowych)

DOBIERZ/api/taskly/home
POST/api/taskly/project-activity
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/details-project
USUŃ/api/taskly/plik-projektu-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/lista-projektów
POST/api/taskly/project-status-update
DOBIERZ/api/taskly/projects
DOBIERZ/api/taskly/projects/{project}/tasks
POST/api/taskly/task-create-update
POST/api/taskly/usunięcie zadania
POST/api/taskly/task-details
POST/api/taskly/lista-zadań
POST/api/taskly/task-stage-update
POST/api/taskly/taskboard
DOBIERZ/api/taskly/users

Śledzenie czasu /api/add-tracker

Uruchamiaj i zatrzymuj moduły śledzące czas. (3 punkty końcowe)

POST/api/add-tracker
POST/api/stop-tracker
POST/api/tracker-login

Użytkownicy i role /api/użytkownicy

Administruj użytkownikami obszaru roboczego i czytaj role. (8 punktów końcowych)

DOBIERZ/api/role
USUŃ/api/user/delete/{id}
POST/api/user/reset-password/{id}
POST/api/użytkownik/sklep
POST/api/user/update/{id}
POSTAW/api/user/verify/{id}
DOBIERZ/api/użytkownicy
DOBIERZ/api/użytkownicy/log

Kadry i płace /api/pracownicy

Pracownicy, frekwencja, urlopy, płace oraz pełna ewidencja HR (oddziały, działy, urlopy, nagrody i inne). (44 punkty końcowe)

DOBIERZ/api/podziękowania
DOBIERZ/api/ogłoszenia
POST/api/attendance/create
USUŃ/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
DOBIERZ/api/obecności
DOBIERZ/api/nagrody
DOBIERZ/api/branże
DOBIERZ/api/skargi
DOBIERZ/api/działy
DOBIERZ/api/oznaczenia
DOBIERZ/api/typy-dokumentów
DOBIERZ/api/employee-transfers
POST/api/pracownik/utwórz
USUŃ/api/pracownik/delete/{id}
DOBIERZ/api/pracownik/show/{id}
POST/api/pracownik/update/{id}
DOBIERZ/api/pracownicy
DOBIERZ/api/wydarzenia
DOBIERZ/api/wakacje
DOBIERZ/api/hrm-documents
POST/api/hrm/historia-obecności
POST/api/hrm/clock-in-out
POST/api/hrm/zdarzenia
DOBIERZ/api/hrm/get-leaves
DOBIERZ/api/hrm/get-leaves-types
DOBIERZ/api/hrm/wakacje-lista
DOBIERZ/api/hrm/home
POST/api/hrm/prośba o urlop
POST/api/leave-application/create
USUŃ/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
DOBIERZ/api/aplikacje-leave
DOBIERZ/api/leave-balances
DOBIERZ/api/leave-types
DOBIERZ/api/place
DOBIERZ/api/payrolls/{payroll_id}
DOBIERZ/api/pasek wypłaty/{payroll_entry_id}
DOBIERZ/api/promocje
DOBIERZ/api/rezygnacje
DOBIERZ/api/przesunięcia
DOBIERZ/api/terminacje
DOBIERZ/api/ostrzeżenia

Interfejs API innej firmy (v1) /api/v1/klienci

Stabilny, wersjonowany kawałek stworzony dla narzędzi niewymagających kodu, takich jak Zapier — klienci i faktury. (7 punktów końcowych)

DOBIERZ/api/v1/klienci
POST/api/v1/klienci
DOBIERZ/api/v1/klienci/{id}
POSTAW/api/v1/klienci/{id}
DOBIERZ/api/v1/faktury
POST/api/v1/faktury
DOBIERZ/api/v1/faktury/{id}

Publiczne punkty końcowe /api/public/plany

Nieuwierzytelnieni pomocnicy: katalog planów publicznych oraz osadzany widget przechwytywania potencjalnych klientów i plakietka partnera. (4 punkty końcowe)

DOBIERZ/api/badge/{token}
DOBIERZ/api/public/plany
POST/api/widget/lead
DOBIERZ/api/widget/{token}

Platforma z białą etykietą /api/wl/plany

Punkty końcowe serwer-serwer używane przez instancje z białą etykietą do rozliczeń i Stripe Connect (uwierzytelnione tokenem). (6 punktów końcowych)

POST/api/wl/checkout
POST/api/wl/connect/onboard
DOBIERZ/api/wl/connect/status
DOBIERZ/api/wl/plany
POST/api/wl/subscription/{stripe_subscription_id}/cancel
POST/api/wl/webhook-callback

Punkty końcowe integracji /api/microsofttodo

Punkty końcowe pomocnicze dla połączonych integracji (Microsoft To Do, Vonage SMS, posty na Facebooku). (3 punkty końcowe)

DOBIERZ/api/facebookpost
DOBIERZ/api/microsofttodo
DOBIERZ/api/vonagesms

Więcej punktów końcowych

Dodatkowe zarejestrowane punkty końcowe. (1 punkty końcowe)

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