API Mewayz Add-on
Ontdek de kracht van de API-integratie van Mewayz voor naadloos project- en taakbeheer. Gemakkelijk uitbreiden en aanpassen. Probeer het nu!
Introductie
De API Docs Generator is een krachtige add-on die volledige API-documentatie biedt voor het Mewayz-platform. Deze add-on helpt ontwikkelaars en technische teams toegang te krijgen tot gedetailleerde API-informatie, inclusief eindpunten, headers, parameters en responsvoorbeelden. De documentatie omvat 14 belangrijke modules van het platform en stelt gebruikers in staat om aangepaste applicaties te bouwen, externe systemen te integreren of API's handmatig te testen met behulp van tools zoals Postman.
Hoe deze module in te schakelen
Om de API Add-On in te stellen, kunt u deze link volgen: Add-on instellen.
Hoe gebruik je de API-add-on?
Genereer API-documenten
Nadat u deze Add-On heeft aangeschaft en geïnstalleerd, gaat u naar de zijbalk van uw dashboard en zoekt u naar de API Docs Add-On.
Om toegang te krijgen tot de API-documentatie, navigeert u vanuit uw hoofddashboard naar de sectie Api Docs. De documentatie is georganiseerd door 14 modulen, waardoor u eenvoudig de specifieke API's kunt vinden die u nodig heeft voor uw integratieproject.
Het gedeelte bevat een algemene inleiding waarin wordt uitgelegd hoe u de API's effectief kunt gebruiken. Dit overzicht omvat authenticatievereisten, algemene headers en basisgebruiksrichtlijnen die van toepassing zijn op alle API-eindpunten.
Elke module bevat krachtige API-lijsten met volledige technische details. Voor elk API-eindpunt vindt u de API-naam, de exacte eindpunt-URL, vereiste headers voor authenticatie en gegevensindeling, invoerparameters met hun gegevenstypen en validatieregels, voorbeeldsuccesreacties die de verwachte gegevensstructuur tonen, en voorbeeldfoutreacties met veelvoorkomende foutcodes en berichten.
Introductie Beheer
Deze uitgebreide API-documentatie is uw toegangspoort tot het benutten van de kracht van de functies van Mewayz, waardoor u uw werk kunt stroomlijnen, de productiviteit kunt verhogen en uw projecten naar een hoger niveau kunt tillen.
Deze API-documentatie is een hulpmiddel voor zowel ervaren als nieuwe ontwikkelaars die de mogelijkheden van Mewayz binnen hun applicaties willen benutten. Dit is wat je kunt verwachten.
U kunt hieronder door de volledige, interactieve referentie in het product bladeren Instellingen → API-documenten.
Het eindpuntengedeelte behandelt GET om gegevens op te halen, POST om nieuwe gegevens te maken, POST om bestaande gegevens bij te werken en DELETE om gegevens te verwijderen. U kunt HTTP-methoden zoals GET gebruiken om gegevens op te halen, POST om nieuwe gegevens te maken, POST om bestaande gegevens bij te werken en DELETE om gegevens te verwijderen.
Verzoekparameters worden gebruikt om het gedrag van uw API-verzoeken aan te passen en om meer specifieke details te bieden bij interactie met de API. Voor Mewayz beschikt u mogelijk over de volgende typen verzoekparameters: Queryparameters om gegevens te filteren of sorteren bij het ophalen van informatie, Request Headers voor authenticatie en aanvullende metagegevens over het verzoek, en Request Body met JSON-gegevens die moeten worden gemaakt of bijgewerkt.
De API van Mewayz reageert doorgaans met gegevens in JSON-indeling. Het antwoord bevat doorgaans een HTTP-statuscode die de uitkomst van het verzoek aangeeft, en de daadwerkelijke gegevens bevinden zich in de “gegevens” veld.
Authenticatiebeheer
Authenticatie-API's bieden de essentiële inlogfunctionaliteit, tokenvernieuwingsmogelijkheden voor het onderhouden van sessies en uitlogprocedures om sessies van eindgebruikers veilig te houden.
Het login-eindpunt POST /api/login vereist headers met “Accepteren”: “applicatie/json” en parameters inclusief e-mail zoals “[email protected]” en een wachtwoord zoals **“john****”**.
Foutreacties retourneren 422 Onverwerkbare inhoud met “succes”: vals, “bericht”: “Validatie Wanneer validatie een fout is.
Foutreacties retourneren 400 Ongeautoriseerd met “succes”: vals, “bericht”: “Het verstrekte” wanneer de inloggegevens ongeldig zijn.
Succesvolle inlogreacties retourneren 200 OK met “succes”: waar en autorisatie met token en type “drager” voor daaropvolgende API-aanroepen.
Het auth-vernieuwingseindpunt POST /api/refresh gebruikt autorisatieheaders met een Bearer-token voor sessiebeheer.
Succesvolle vernieuwingsreacties retourneren gedetailleerde gebruikersinformatie, waaronder 200 OK met “succes”: waar, en gebruikersgegevens, id, naam, e-mailadres, mobiel_nr, type: “bedrijf”, avatar: “URL”, lang: “nl” en teken.
Gebruikersbeheer
- Gebruikers-API's voor gebruikersbeheer, rolbeheer en profiel
operaties.
Magazijnbeheer
- Magazijn-API's voor magazijnconfiguratie en magazijnoverdrachten
beheer.
Product- en servicebeheer
- API's in de product- en servicesectie beheren productcategorieën, belastingen,
meeteenheden, producten en voorraadbeheer met magazijnintegratie.
Beheer van inkoopfacturen
- Inkoopfactuur-API's voor inkoopfactuurlijst, aanmaken, detail,
Updaten, verwijderen, beheer van factuurposten.
Beheer van aankoopretouren
- API's voor het verwerken van de retourlijst voor aankopen, creëren, retourdetails,
Verwijderen, goedkeuren, verwerking voltooien.
Beheer van verkoopvoorstellen
- Verkoopvoorstel-API's voor voorstelbeheer en conversie
processen.
Beheer van verkoopfacturen
- Verkoopfactuur-API's verwerken de factuurlijst, het maken, bijwerken, verwijderen,
Factuurpostbeheer.
Beheer van retourzendingen van verkoopfacturen
- API's voor het beheren van de verkoopfactuurretourlijst, creëren, detailleren, verwijderen,
Goedkeuren en voltooien.
Accountbeheer
- Met de API's in de accountsectie kunt u klanten, leveranciers,
- De Accountmodule bevat snelle lijst-API's voor het eenvoudig ophalen
Bankrekeningen, rekeningschema, inkomsten, uitgaven, creditnota's, debetnota's, leveranciersbetalingen, klantbetalingen, banktransacties, bankoverschrijvingen. U kunt indien nodig bewerkingen uitvoeren zoals het weergeven van records, het maken van nieuwe vermeldingen, het bekijken van details, het bijwerken van informatie en het verwijderen van records.
klanten- en leverancierslijsten, Gl-accountlijst, samen met inkomsten- en onkostencategorieën voor vervolgkeuzelijsten en snelle referenties.
Projectmanagement
- API's voor projectsecties beheren projecten, taken, bugs, mijlpalen,
bestanden en verschillende rapporten met de bijbehorende fasen en workflows.
POS-beheer
- POS-API's verzorgen verkooppuntactiviteiten, inclusief orderbeheer
en bestelgegevens.
CRM-beheer
- API's in het CRM-gedeelte omvatten pijplijnbeheer, lead- en dealfasen,
labels, bronnen en compleet Leadbeheer en Dealbeheer. U kunt taken, gebruikers, producten, bronnen, e-mails, discussies, bestanden en oproepen beheren die zijn gekoppeld aan zowel leads als deals.
HRM-management
- HRM API's verzorgen het personeelsbeheer, de organisatiestructuur,
aanwezigheidsregistratie, verlofbeheer, salarisverwerking en verschillende HR-gegevens, waaronder prijzen, promoties, ontslag, beëindigingen, waarschuwingen, klachten, overplaatsingen van werknemers, vakanties, evenementen, documenten, aankondigingen en dankbetuigingen.
Elk API-eindpunt in de documentatie bevat praktische voorbeelden die u rechtstreeks in uw ontwikkelomgeving of testtools kunt kopiëren en gebruiken. De antwoordvoorbeelden tonen zowel succesvolle bewerkingen als veelvoorkomende foutscenario's, zodat u de juiste foutafhandeling in uw toepassingen kunt implementeren.
Modules Wise API's Lijst:
- Authenticatie:
- Login
- Token vernieuwen
- Uitloggen
- Gebruiker:
- Gebruiker: Lijst, maken, bijwerken, verwijderen,
- Rol : Lijst
- Gebruikerslogboek: Lijst
- Personeelsgebruikers: Lijst
- Klantgebruikers: Lijst
- Leveranciersgebruikers: Lijst
- Magazijn:
Profielupdate, wachtwoordupdate, wachtwoord opnieuw instellen, verifiëren
- Magazijn: Lijst, creëren, detail, bijwerken,
- Overdracht: Lijst, aanvraaggegevens aanmaken,
- Product & Dienst:
Verwijderen
Maken, verwijderen
- Productcategorie: Lijst, maken, bijwerken,
- Belasting : Lijst, maken, bijwerken, verwijderen
- Eenheid: Lijst, maken, bijwerken, verwijderen
- Artikel: Lijst, creëren, detail, bijwerken,
- Productvoorraad: Lijst, toevoegen
- Magazijnproduct: Lijst
- Aankoopfactuur:
Verwijderen
Verwijderen
- Factuur: Lijst, creëren, detail, bijwerken,
- Aankoop retourneren:
Verwijderen, posten
- Retour: Lijst, Maken, Detail, Verwijderen,
- Verkoopvoorstel:
Goedkeuren, voltooien
- Voorstel: Lijst, creëren, detail, bijwerken,
- Verkoopfactuur:
Verwijderen, Verzonden, Accepteren, Weigeren, Converteren naar factuur
- Factuur: Lijst, creëren, detail, bijwerken,
- Retour verkoopfactuur:
Verwijderen, posten
- Retour: Lijst, Maken, Detail, Verwijderen,
- Rekening :
Goedkeuren, voltooien
- Klanten krijgen: Eenvoudige klantenlijst
- Leveranciers verkrijgen: Eenvoudige leverancierslijst
- Klant: Lijst, maken, bijwerken, verwijderen
- Verkoper: Lijst, maken, bijwerken, verwijderen
- Gl-account: Lijst
- Bankrekening: Lijst, maken, bijwerken, verwijderen
- Inkomstencategorieën: Lijst
- Inkomsten : Lijst, maken, bijwerken, verwijderen,
- Onkostencategorieën: Lijst
- Kosten: Lijst, maken, bijwerken, verwijderen,
- Accounttypen: Lijst
- Rekeningschema: Lijst
- Banktransactie: Lijst
- Bankoverschrijving: Lijst
- Leveranciersbetalingen: Lijst
- Klantbetalingen: Lijst
- Creditnota: Lijst
- Debetnota: Lijst
- Project:
Goedkeuren, posten
Goedkeuren, posten
- Project: Lijst, creëren, detail, bijwerken,
- Projectlid: Verwijderen
- Projectklant: Lijst, uitnodigen, verwijderen
- Projectmijlpaal: Lijst, maken, bijwerken,
- Projectbestand: Maken, verwijderen
- Taak: Taakbord, Maken, Detail, Bijwerken,
- Taakcommentaar: Maken, verwijderen
- Taaksubtaak: Maken, bijwerken
- Bugstatus: Lijst
- Fout: Lijst, Maken, Detail, Bijwerken, Verwijderen
- Bugcommentaar: Maken, verwijderen
- Projectrapport: Lijst, details
- Taakfase: Lijst, bestellen, creëren, bijwerken,
- Bugfase: Lijst, bestellen, creëren, bijwerken,
- POS:
Verwijderen
Verwijderen
Verwijderen
Verwijderen
Verwijderen
- Bestelling: Lijst, details
- CRM:
- Pijpleiding: Lijst, maken, bijwerken, verwijderen
- Hoofdstadium: Lijst, maken, bijwerken, verwijderen
- Dealfase: Lijst, maken, bijwerken, verwijderen
- Etiketten: Lijst, maken, bijwerken, verwijderen
- Bronnen: Lijst, maken, bijwerken, verwijderen
- Lood: Lijst, creëren, detail, bijwerken,
- Hoofdtaak: Maken, bijwerken, verwijderen
- Hoofdgebruiker: Maken, verwijderen
- Hoofdproduct: Maken, verwijderen
- Leadbron: Maken, verwijderen
- Lead-e-mail: Creëer
- Leidende discussie: Creëer
- Hoofdbestand: Maken, verwijderen
- Hoofdoproep: Maken, bijwerken, verwijderen
- Aanbieding: Lijst, creëren, detail, bijwerken,
- Dealtaak: Maken, bijwerken, verwijderen
- Dealgebruiker: Maken, verwijderen
- Aanbiedingsproduct: Maken, verwijderen
- Bron van deal: Maken, verwijderen
- Aanbiedings-e-mail: Creëer
- Dealbespreking: Creëer
- Dealbestand: Maken, verwijderen
- Dealklant: Maken, verwijderen
- Dealoproep: Maken, bijwerken, verwijderen
- HRM:
Verwijderen, label toevoegen, converteren naar deal
Verwijderen, label toevoegen
- Medewerker : Lijst, creëren, detail, bijwerken,
- Aanwezigheid: Lijst, maken, bijwerken, verwijderen
- Verloftypen: Lijst
- Laat sollicitaties achter: Lijst, maken, bijwerken,
- Verlaat saldi: Controleer
- Loonadministratie : Lijst, details
- Loonstrook: Genereer
- Verschuivingen: Lijst
- Takken: Lijst
- Afdelingen: Lijst
- Benamingen: Lijst
- Documenttypen: Lijst
- Feestdagen : Lijst
- Onderscheidingen: Lijst
- Promoties : Lijst
- Ontslag: Lijst
- Beëindigingen: Lijst
- Waarschuwingen: Lijst
- Klachten: Lijst
- Overplaatsingen van werknemers: Lijst
- Documenten: Lijst
- Dankbetuigingen: Lijst
- Mededelingen: Lijst
- Evenementen: Lijst
Verwijderen
Verwijderen, status bijwerken