API Mewayz tilføjelse
Oplev styrken ved Mewayzs API-integration til problemfri projekt- og opgavestyring. Udvid og tilpas med lethed. Prøv nu!
Indledning
API Docs Generator er en kraftfuld tilføjelse, der giver komplet API-dokumentation til Mewayz-platformen. Denne tilføjelse hjælper udviklere og tekniske teams med at få adgang til detaljerede API-oplysninger, herunder slutpunkter, overskrifter, parametre og svareksempler. Dokumentationen dækker 14 store moduler af platformen og gør det muligt for brugere at bygge brugerdefinerede applikationer, integrere eksterne systemer eller teste API'er manuelt ved hjælp af værktøjer som Postman.
Sådan aktiverer du dette modul
For at konfigurere API-tilføjelsen kan du følge dette link: Opsætning af tilføjelse.
Hvordan bruger man API-tilføjelsen?
Generer Api Docs
Når du har købt og installeret denne tilføjelse, skal du gå til sidepanelet på dit dashboard og søge efter API Docs-tilføjelsen.
For at få adgang til API-dokumentationen skal du navigere til Api Docs-sektionen fra dit hovedbetjeningspanel. Dokumentationen er tilrettelagt af 14 moduler, hvilket gør det nemt at finde de specifikke API'er, du har brug for til dit integrationsprojekt.
Afsnittet indeholder en generel introduktion, der forklarer, hvordan man bruger API'erne effektivt. Denne oversigt dækker godkendelseskrav, fælles overskrifter og grundlæggende brugsretningslinjer, der gælder på tværs af alle API-endepunkter.
Hvert modul indeholder kraftfulde API-lister med komplette tekniske detaljer. For hvert API-slutpunkt finder du API-navnet, den nøjagtige slutpunkts-URL, påkrævede overskrifter til godkendelse og dataformat, inputparametre med deres datatyper og valideringsregler, eksempler på successvar, der viser den forventede datastruktur, og eksempler på fejlsvar med almindelige fejlkoder og meddelelser.
Introduktion Ledelse
Denne omfattende API-dokumentation er din gateway til at udnytte styrken af Mewayzs funktioner, så du kan strømline dit arbejde, øge produktiviteten og bringe dine projekter til næste niveau.
Denne API-dokumentation er en ressource for udviklere, både erfarne og nye, som ønsker at udnytte Mewayzs muligheder i deres applikationer. Her er, hvad du kan forvente at finde.
Du kan gennemse hele den interaktive reference inde i produktet under Indstillinger → API-dokumenter.
Endpoints-sektionen dækker GET for at hente data, POST for at oprette nye data, POST for at opdatere eksisterende data og DELETE for at fjerne data. Du kan bruge HTTP-metoder som GET til at hente data, POST til at oprette nye data, POST til at opdatere eksisterende data og DELETE for at fjerne data.
Forespørgselsparametre bruges til at tilpasse adfærden af dine API-anmodninger og give mere specifikke detaljer, når du interagerer med API'en. For Mewayz kan du have følgende typer anmodningsparametre: Forespørgselsparametre til at filtrere eller sortere data ved hentning af oplysninger, Anmodningshoveder til godkendelse og yderligere metadata om anmodningen og Anmodningstekst, der indeholder JSON-data, der skal oprettes eller opdateres.
Mewayzs API svarer typisk med data i JSON-format. Svaret inkluderer typisk en HTTP-statuskode, der angiver resultatet af anmodningen, og de faktiske data er indeholdt i "data" felt.
Autentificeringsstyring
Autentificerings-API'er giver den væsentlige login-funktionalitet, token-opdateringsfunktioner til at vedligeholde sessioner og logout-procedurer for at sikre slutbrugersessioner.
Login-slutpunktet POST /api/login kræver overskrifter med "Accepter": "applikation/json" og parametre inklusive e-mail som "[email protected]" og adgangskode som **“john****”**.
Fejlsvar returnerer 422 Ubearbejdeligt indhold med "succes": falsk, "besked": “Validation Når validering er en fejl.
Fejlsvar returnerer 400 Uautoriseret med "succes": falsk, "besked": “Det leverede” når legitimationsoplysninger er ugyldige.
Vellykkede login-svar returnerer 200 OK med "succes": sand og autorisation indeholdende token og type "bærer" til efterfølgende API-kald.
Auth refresh-slutpunktet POST /api/refresh bruger autorisationsheadere med et bærertoken til sessionsstyring.
Vellykkede opdateringssvar returnerer detaljerede brugeroplysninger, inklusive 200 OK med "succes": sand, og brugeroplysninger, id, navn, e-mail, mobile_no, skriv: "virksomhed", avatar: "URL", lang: "da" og token.
Brugerstyring
- Bruger-API'er til brugeradministration, rollestyring og profil
operationer.
Lagerstyring
- Warehouse API'er til lagerkonfiguration og lageroverførsler
ledelse.
Produkt & Service Management
- Produkt- og servicesektionens API'er administrerer produktkategorier, afgifter,
måleenheder, produkter og lagerstyring med lagerintegration.
Indkøbsfakturastyring
- Purchase Invoice API'er til Purchase Invoice List, Create, Detail,
Opdater, Slet, Fakturapoststyring.
Indkøbsreturhåndtering
- API'er til håndtering af indkøbsreturliste, oprettelse, returdetaljer,
Slet, Godkend, Fuldfør behandlingen.
Salgsforslagsstyring
- Salgsforslag API'er til forslagsstyring og konvertering
processer.
Salgsfakturastyring
- Sales Invoice API'er håndterer fakturaliste, oprettelse, opdatering, sletning,
Håndtering af fakturapost.
Salgsfaktura returstyring
- API'er til styring af salgsfakturareturliste, Opret, Detaljer, Slet,
Godkend og udfyld.
Kontostyring
- Kontosektionens API'er giver dig mulighed for at administrere kunder, leverandører,
- Kontomodulet inkluderer hurtigliste-API'er til enkel hentning
Bankkonti, kontoplan, indtægter, udgifter, kreditnotaer, debetnotaer, kreditorbetalinger, kundebetalinger, banktransaktioner, bankoverførsler. Du kan udføre handlinger som at angive poster, oprette nye poster, se detaljer, opdatere oplysninger og slette poster efter behov.
kunde- og leverandørlister, Gl Account List, sammen med indtægts- og udgiftskategorier til dropdown-valg og hurtige referencer.
Projektledelse
- Projektsektions-API'er administrerer projekter, opgaver, fejl, milepæle,
filer og forskellige rapporter med tilhørende faser og arbejdsgange.
POS Management
- POS API'er håndterer point-of-sale operationer, herunder ordrestyring
og ordredetaljer.
CRM Management
- CRM sektions API'er dækker pipeline management, lead og deal faser,
etiketter, kilder og komplet kundeemnestyring og aftalestyring. Du kan administrere opgaver, brugere, produkter, kilder, e-mails, diskussioner, filer og opkald forbundet med både kundeemner og aftaler.
HRM ledelse
- HRM API'er håndterer medarbejderledelse, organisationsstruktur,
tilstedeværelsessporing, orlovshåndtering, lønbehandling og forskellige HR-registreringer, herunder priser, forfremmelser, fratrædelser, opsigelser, advarsler, klager, medarbejderoverførsler, ferier, begivenheder, dokumenter, meddelelser og anerkendelser.
Hvert API-endepunkt i dokumentationen indeholder praktiske eksempler, som du kan kopiere og bruge direkte i dit udviklingsmiljø eller testværktøjer. Svareksemplerne viser både vellykkede operationer og almindelige fejlscenarier, der hjælper dig med at implementere korrekt fejlhåndtering i dine applikationer.
Modules Wise APIs List:
- Godkendelse:
- Log ind
- Token Opdater
- Log ud
- Bruger:
- Bruger: Liste, Opret, Opdater, Slet,
- Rolle: Liste
- Brugerlog: Liste
- Personale brugere: Liste
- Klientbrugere: Liste
- Leverandørbrugere: Liste
- Lager:
Profilopdatering, Adgangskodeopdatering, Nulstil adgangskode, Bekræft
- Lager: Liste, Opret, Detaljer, Opdater,
- Overførsel: Liste, oprette anmodningsdata,
- Produkt & Service:
Slet
Opret, Slet
- Produktkategori: Liste, Opret, Opdater,
- Skat: Liste, Opret, Opdater, Slet
- Enhed: Liste, Opret, Opdater, Slet
- Produkt: Liste, Opret, Detaljer, Opdater,
- Produktlager: Liste, Tilføj
- Lagerprodukt: Liste
- Købsfaktura:
Slet
Slet
- Faktura: Liste, Opret, Detaljer, Opdater,
- Køb retur:
Slet, post
- Retur: Liste, Opret, Detaljer, Slet,
- Salgsforslag:
Godkend, Fuldfør
- Forslag: Liste, Opret, Detaljer, Opdater,
- Salgsfaktura:
Slet, Sendt, Accepter, Afvis, Konverter til Faktura
- Faktura: Liste, Opret, Detaljer, Opdater,
- Returnering af salgsfaktura:
Slet, post
- Retur: Liste, Opret, Detaljer, Slet,
- Konto:
Godkend, Fuldfør
- Få kunder: Enkel kundeliste
- Få leverandører: Enkel leverandørliste
- Kunde: Liste, Opret, Opdater, Slet
- Sælger: Liste, Opret, Opdater, Slet
- Gl konto: Liste
- Bankkonto: Liste, Opret, Opdater, Slet
- Indtægtskategorier: Liste
- Indtægter: Liste, Opret, Opdater, Slet,
- Udgiftskategorier: Liste
- Udgift: Liste, Opret, Opdater, Slet,
- Kontotyper: Liste
- Kontoplan: Liste
- Banktransaktion: Liste
- Bankoverførsel: Liste
- Leverandørbetalinger: Liste
- Kundebetalinger: Liste
- Kreditnota: Liste
- Debetnota: Liste
- Projekt:
Godkend, post
Godkend, post
- Projekt: Liste, Opret, Detaljer, Opdater,
- Projektmedlem: Slet
- Projektkunde: Liste, invitere, slette
- Projektets milepæl: Liste, Opret, Opdater,
- Projekt fil: Opret, Slet
- Opgave: Task Board, Opret, Detaljer, Opdater,
- Opgavekommentar: Opret, Slet
- Opgave Underopgave: Opret, opdater
- Fejlstatus: Liste
- Bug: Liste, Opret, Detaljer, Opdater, Slet
- Fejlkommentar: Opret, Slet
- Projektrapport: Liste, detalje
- Opgavestadie: Liste, Bestil, Opret, Opdater,
- Bug Stage: Liste, Bestil, Opret, Opdater,
- POS:
Slet
Slet
Slet
Slet
Slet
- Ordre: Liste, detalje
- CRM:
- Rørledning: Liste, Opret, Opdater, Slet
- Lead Stage: Liste, Opret, Opdater, Slet
- Aftalefase: Liste, Opret, Opdater, Slet
- Etiketter: Liste, Opret, Opdater, Slet
- Kilder: Liste, Opret, Opdater, Slet
- bly: Liste, Opret, Detaljer, Opdater,
- Hovedopgave: Opret, Opdater, Slet
- Hovedbruger: Opret, Slet
- Hovedprodukt: Opret, Slet
- Hovedkilde: Opret, Slet
- Lead email: Opret
- Hoveddiskussion: Opret
- Blyfil: Opret, Slet
- Lead Call: Opret, Opdater, Slet
- Aftale: Liste, Opret, Detaljer, Opdater,
- Aftaleopgave: Opret, Opdater, Slet
- Deal bruger: Opret, Slet
- Deal produkt: Opret, Slet
- Aftalekilde: Opret, Slet
- Aftale e-mail: Opret
- Deal diskussion: Opret
- Aftalefil: Opret, Slet
- Deal klient: Opret, Slet
- Aftaleopkald: Opret, Opdater, Slet
- HRM:
Slet, Tilføj etiket, Konverter til aftale
Slet, Tilføj etiket
- Medarbejder: Liste, Opret, Detaljer, Opdater,
- Deltagelse: Liste, Opret, Opdater, Slet
- Orlovstyper: Liste
- Forlad ansøgninger: Liste, Opret, Opdater,
- Efterlad saldi: Tjek
- Løn: Liste, detalje
- Lønseddel: Generer
- Skifter: Liste
- Filialer: Liste
- Afdelinger: Liste
- Betegnelser: Liste
- Dokumenttyper: Liste
- Helligdage: Liste
- Præmier: Liste
- Kampagner: Liste
- Opsigelser: Liste
- Opsigelser: Liste
- Advarsler: Liste
- Klager: Liste
- Medarbejderoverførsler: Liste
- Dokumenter: Liste
- Anerkendelser: Liste
- Meddelelser: Liste
- Begivenheder: Liste
Slet
Slet, opdater status