Dodatek API Mewayz
Odkryj moc integracji API Mewayz w celu płynnego zarządzania projektami i zadaniami. Z łatwością rozszerzaj i dostosowuj. Spróbuj teraz!
Adres URL wersji demonstracyjnej
Wprowadzenie
Generator Dokumentów API to potężny dodatek, który zapewnia pełną dokumentację API dla platformy Mewayz. Ten dodatek pomaga programistom i zespołom technicznym uzyskać dostęp do szczegółowych informacji o interfejsie API, w tym o punktach końcowych, nagłówkach, parametrach i przykładach odpowiedzi. Dokumentacja obejmuje 14 głównych modułów platformy i umożliwia użytkownikom budowanie niestandardowych aplikacji, integrację systemów zewnętrznych lub ręczne testowanie API za pomocą narzędzi takich jak Postman.
Jak włączyć ten moduł
Aby skonfigurować dodatek API, kliknij ten link: Skonfiguruj dodatek.
Jak korzystać z dodatku API?
Wygeneruj dokumenty API
Po zakupie i zainstalowaniu tego dodatku przejdź do paska bocznego pulpitu nawigacyjnego i wyszukaj dodatek API Dokumenty.
Aby uzyskać dostęp do dokumentacji API, przejdź do sekcji Dokumenty Api na głównym pulpicie nawigacyjnym. Dokumentację organizuje 14 modułów, co ułatwia znalezienie konkretnych interfejsów API potrzebnych w projekcie integracji.
Ta sekcja zawiera ogólne wprowadzenie wyjaśniające, jak efektywnie korzystać z interfejsów API. W tym przeglądzie omówiono wymagania dotyczące uwierzytelniania, typowe nagłówki i podstawowe wytyczne dotyczące użytkowania, które mają zastosowanie we wszystkich punktach końcowych interfejsu API.
Każdy moduł zawiera zaawansowane wykazy API z pełnymi szczegółami technicznymi. Dla każdego punktu końcowego API znajdziesz nazwę API, dokładny adres URL punktu końcowego, wymagane nagłówki do uwierzytelnienia i formatu danych, parametry wejściowe z ich typami danych i regułami sprawdzania poprawności, przykładowe odpowiedzi zakończone sukcesem pokazujące oczekiwaną strukturę danych oraz przykładowe odpowiedzi na błędy z typowymi kodami błędów i komunikatami.
Wprowadzenie Zarządzanie
Ta obszerna dokumentacja API jest Twoją bramą do wykorzystania mocy funkcji Mewayz, pozwalając Ci usprawnić pracę, zwiększyć produktywność i przenieść swoje projekty na wyższy poziom.
Ta dokumentacja API jest źródłem informacji dla programistów, zarówno doświadczonych, jak i nowych, którzy chcą wykorzystać możliwości Mewayz w swoich aplikacjach. Oto, czego możesz się spodziewać.
Możesz przeglądać pełne, interaktywne informacje wewnątrz produktu pod Ustawienia → Dokumenty API.
Sekcja punktów końcowych obejmuje GET w celu pobrania danych, POST w celu utworzenia nowych danych, POST w celu aktualizacji istniejących danych i DELETE w celu usunięcia danych. Możesz użyć metod HTTP, takich jak GET do pobrania danych, POST do utworzenia nowych danych, POST do aktualizacji istniejących danych i DELETE do usunięcia danych.
Parametry żądania służą do dostosowywania zachowania żądań API i dostarczania bardziej szczegółowych szczegółów podczas interakcji z interfejsem API. Dla Mewayz możesz mieć następujące typy parametrów żądania: Parametry zapytania do filtrowania lub sortowania danych podczas pobierania informacji, Nagłówki żądania do uwierzytelniania i dodatkowych metadanych na temat żądania oraz Treść żądania zawierająca dane JSON do utworzenia lub aktualizacji.
Interfejs API Mewayz zazwyczaj odpowiada danymi w formacie JSON. Odpowiedź zazwyczaj zawiera kod stanu HTTP wskazujący wynik żądania, a rzeczywiste dane są zawarte w pliku „dane” pole.
Zarządzanie uwierzytelnianiem
Interfejsy API uwierzytelniania zapewniają podstawową funkcjonalność logowania, możliwość odświeżania tokenów w celu utrzymania sesji oraz procedury wylogowania w celu bezpiecznego sesji użytkownika końcowego.
Punkt końcowy logowania POST /api/login wymaga nagłówków with „Zaakceptuj”: „aplikacja/json” i parametry, w tym e-mail „[email protected]” i hasło takie jak **„John****”**.
Odpowiedzi na błędy zwracają treść 422 nieprzetworzoną „sukces”: fałszywe, „wiadomość”: „Walidacja Gdy walidacja jest błędem.
Odpowiedzi na błędy zwracają 400 Nieautoryzowane z „sukces”: fałszywe, „wiadomość”: “Dostarczone” gdy dane uwierzytelniające są nieważne.
Pomyślne odpowiedzi na logowanie zwracają 200 OK „sukces”: true i autoryzacja zawierająca token i typ „nosiciel” dla kolejnych wywołań API.
Punkt końcowy odświeżania uwierzytelniania POST /api/refresh używa nagłówków autoryzacji z tokenem nośnika do zarządzania sesją.
Pomyślne odpowiedzi na odświeżenie zwracają szczegółowe informacje o użytkowniku, w tym 200 OK „sukces”: true i dane użytkownika, identyfikator, nazwa, adres e-mail, numer telefonu komórkowego, wpisz: „firma”, awatar: „URL”, język: „pl” i token.
Zarządzanie użytkownikami
- Interfejsy API użytkownika do administrowania użytkownikami, zarządzania rolami i profilami
operacje.
Zarządzanie magazynem
- Interfejsy API hurtowni do konfiguracji magazynu i przesunięć magazynu
zarządzanie.
Zarządzanie produktami i usługami
- Interfejsy API sekcji produktów i usług zarządzają kategoriami produktów, podatkami,
jednostki miary, produkty i zarządzanie zapasami wraz z integracją magazynu.
Zarządzanie fakturami zakupu
- Interfejsy API faktur zakupu dla listy faktur zakupu, tworzenia, szczegółów,
Aktualizacja, usuwanie, zarządzanie księgowaniem faktur.
Zarządzanie zwrotami zakupów
- API do obsługi listy zwrotów zakupów, tworzenia, szczegółów zwrotu,
Usuń, zatwierdź, zakończ przetwarzanie.
Zarządzanie propozycjami sprzedaży
- Interfejsy API propozycji sprzedaży do zarządzania ofertami i konwersji
procesy.
Zarządzanie fakturami sprzedaży
- Interfejsy API faktur sprzedaży obsługują listę faktur, tworzenie, aktualizację, usuwanie,
Zarządzanie księgowaniem faktur.
Zarządzanie zwrotami faktur sprzedaży
- API do zarządzania listą zwrotów faktur sprzedażowych, tworzeniem, szczegółami, usuwaniem,
Zatwierdź i zakończ.
Zarządzanie kontem
- Interfejsy API sekcji Konto umożliwiają zarządzanie Klientami, Dostawcami,
- Moduł Konto zawiera interfejsy API szybkiej listy umożliwiające proste pobieranie
Rachunki bankowe, plan kont, przychody, wydatki, noty kredytowe, noty debetowe, płatności dostawcy, płatności klientów, transakcje bankowe, zapisy przelewów bankowych. Możesz wykonywać operacje, takie jak wystawianie rekordów na listę, tworzenie nowych wpisów, przeglądanie szczegółów, aktualizowanie informacji i usuwanie rekordów, jeśli zajdzie taka potrzeba.
listy klientów i dostawców, lista kont Gl wraz z kategoriami przychodów i wydatków do wyboru z listy rozwijanej i szybkich referencji.
Zarządzanie projektami
- Interfejsy API sekcji projektów zarządzają projektami, zadaniami, błędami, kamieniami milowymi,
pliki oraz różne raporty z powiązanymi z nimi etapami i przepływami pracy.
Zarządzanie punktami sprzedaży
- Interfejsy API POS obsługują operacje w punktach sprzedaży, w tym zarządzanie zamówieniami
i Szczegóły zamówienia.
Zarządzanie CRM-em
- Interfejsy API sekcji CRM obejmują zarządzanie rurociągami, etapy leadów i transakcji,
etykiety, źródła i pełne zarządzanie potencjalnymi klientami oraz zarządzanie transakcjami. Możesz zarządzać zadaniami, użytkownikami, produktami, źródłami, e-mailami, dyskusjami, plikami i połączeniami powiązanymi zarówno z potencjalnymi klientami, jak i transakcjami.
Zarządzanie zasobami ludzkimi
- Interfejsy API HRM obsługują zarządzanie pracownikami, strukturą organizacyjną,
śledzenie obecności, zarządzanie urlopami, przetwarzanie list płac i różne rejestry kadrowe, w tym nagrody, promocje, rezygnacje, rozwiązania stosunku pracy, ostrzeżenia, skargi, przeniesienia pracowników, urlopy, wydarzenia, dokumenty, ogłoszenia i podziękowania.
Każdy punkt końcowy interfejsu API w dokumentacji zawiera praktyczne przykłady, które można skopiować i wykorzystać bezpośrednio w środowisku programistycznym lub narzędziach testowych. Przykłady odpowiedzi przedstawiają zarówno pomyślne operacje, jak i typowe scenariusze błędów, pomagając wdrożyć odpowiednią obsługę błędów w aplikacjach.
Lista modułów Wise API:
- Uwierzytelnianie:
- Login
- Odświeżenie tokena
- Wyloguj się
- Użytkownik:
- Użytkownik: Lista, Utwórz, Aktualizuj, Usuń,
- Rola: Lista
- Dziennik użytkownika: Lista
- Użytkownicy personelu: Lista
- Użytkownicy Klienta: Lista
- Użytkownicy dostawcy: Lista
- Magazyn:
Aktualizacja profilu, aktualizacja hasła, resetowanie hasła, zweryfikowanie
- Magazyn: Lista, Utwórz, Szczegóły, Aktualizuj,
- Przelew: Lista, Utwórz dane żądania,
- Produkt i usługa:
Usuń
Utwórz, usuń
- Kategoria produktu: Lista, Utwórz, Aktualizuj,
- Podatek: Lista, tworzenie, aktualizacja, usuwanie
- Jednostka: Lista, tworzenie, aktualizacja, usuwanie
- Produkt: Lista, Utwórz, Szczegóły, Aktualizuj,
- Zapasy produktów: Lista, dodaj
- Produkt magazynowy: Lista
- Faktura zakupu:
Usuń
Usuń
- Faktura: Lista, Utwórz, Szczegóły, Aktualizuj,
- Zwrot zakupu:
Usuń, opublikuj
- Powrót: Lista, Utwórz, Szczegóły, Usuń,
- Propozycja sprzedaży:
Zatwierdź, ukończ
- Propozycja: Lista, Utwórz, Szczegóły, Aktualizuj,
- Faktura sprzedaży:
Usuń, Wysłane, Zaakceptuj, Odrzuć, Konwertuj na fakturę
- Faktura: Lista, Utwórz, Szczegóły, Aktualizuj,
- Zwrot faktury sprzedaży:
Usuń, opublikuj
- Powrót: Lista, Utwórz, Szczegóły, Usuń,
- Konto:
Zatwierdź, ukończ
- Zdobądź klientów: Prosta lista klientów
- Zdobądź dostawców: Prosta lista dostawców
- Klient: Lista, tworzenie, aktualizacja, usuwanie
- Sprzedawca: Lista, tworzenie, aktualizacja, usuwanie
- Konto Gl: Lista
- Konto bankowe: Lista, tworzenie, aktualizacja, usuwanie
- Kategorie przychodów : Lista
- Przychody: Lista, Utwórz, Aktualizuj, Usuń,
- Kategorie wydatków: Lista
- Wydatki: Lista, Utwórz, Aktualizuj, Usuń,
- Typy kont: Lista
- Plan kont: Lista
- Transakcja bankowa: Lista
- Przelew bankowy: Lista
- Płatności dostawcy: Lista
- Płatności klientów: Lista
- Nota kredytowa: Lista
- Nota debetowa: Lista
- Projekt:
Zatwierdź, opublikuj
Zatwierdź, opublikuj
- Projekt: Lista, Utwórz, Szczegóły, Aktualizuj,
- Członek projektu: Usuń
- Klient projektu: Dodaj, zaproś, usuń
- Kamień milowy projektu: Lista, Utwórz, Aktualizuj,
- Plik projektu: Utwórz, usuń
- Zadanie: Tablica zadań, utwórz, szczegółowo, zaktualizuj,
- Komentarz do zadania: Utwórz, usuń
- Podzadanie zadania: Twórz, aktualizuj
- Stan błędu: Lista
- Błąd: Lista, tworzenie, szczegóły, aktualizacja, usuwanie
- Komentarz do błędu: Utwórz, usuń
- Raport projektu: Lista, szczegół
- Etap zadania: Lista, zamówienie, tworzenie, aktualizacja,
- Etap błędu: Lista, zamówienie, tworzenie, aktualizacja,
- Punkt sprzedaży:
Usuń
Usuń
Usuń
Usuń
Usuń
- Zamówienie: Lista, szczegół
- CRM:
- Rurociąg: Lista, tworzenie, aktualizacja, usuwanie
- Etap wiodący: Lista, tworzenie, aktualizacja, usuwanie
- Etap transakcji: Lista, tworzenie, aktualizacja, usuwanie
- Etykiety: Lista, tworzenie, aktualizacja, usuwanie
- Źródła: Lista, tworzenie, aktualizacja, usuwanie
- Ołów: Lista, Utwórz, Szczegóły, Aktualizuj,
- Główne zadanie: Utwórz, zaktualizuj, usuń
- Główny użytkownik: Utwórz, usuń
- Główny produkt: Utwórz, usuń
- Źródło potencjalnego klienta: Utwórz, usuń
- Główny adres e-mail: Utwórz
- Główna dyskusja: Utwórz
- Plik wiodący: Utwórz, usuń
- Wiodące połączenie: Utwórz, zaktualizuj, usuń
- Oferta: Lista, Utwórz, Szczegóły, Aktualizuj,
- Zadanie rozdania: Utwórz, zaktualizuj, usuń
- Użytkownik oferty: Utwórz, usuń
- Produkt objęty promocją: Utwórz, usuń
- Źródło oferty: Utwórz, usuń
- E-mail dotyczący oferty: Utwórz
- Dyskusja na temat oferty: Utwórz
- Plik transakcji: Utwórz, usuń
- Klient oferty: Utwórz, usuń
- Zadzwoń do oferty: Utwórz, zaktualizuj, usuń
- Zarządzanie zasobami ludzkimi:
Usuń, dodaj etykietę, skonwertuj na transakcję
Usuń, dodaj etykietę
- Pracownik: Lista, Utwórz, Szczegóły, Aktualizuj,
- Frekwencja: Lista, tworzenie, aktualizacja, usuwanie
- Typy urlopów: Lista
- Zostaw aplikacje: Lista, Utwórz, Aktualizuj,
- Pozostaw saldo: Sprawdź
- Lista płac: Lista, szczegół
- odcinek wypłaty: Wygeneruj
- Zmiany: Lista
- Oddziały: Lista
- Działy: Lista
- Oznaczenia: Lista
- Typy dokumentów: Lista
- Święta: Lista
- Nagrody: Lista
- Promocje: Lista
- Rezygnacje: Lista
- Zakończenia: Lista
- Ostrzeżenia: Lista
- Reklamacje: Lista
- Transfery pracowników: Lista
- Dokumenty: Lista
- Podziękowania: Lista
- Ogłoszenia: Lista
- Wydarzenia: Lista
Usuń
Usuń, zaktualizuj status