Componente aggiuntivo API Mewayz
Scopri la potenza dell'integrazione API di Mewayz per una gestione fluida di progetti e attività. Estendi e personalizza con facilità. Prova ora!
Introduzione
L'API Docs Generator è un potente Add-On che fornisce una documentazione API completa per la piattaforma Mewayz. Questo Add-On aiuta sviluppatori e team tecnici ad accedere a informazioni API dettagliate, tra cui endpoint, header, parametri ed esempi di risposta. La documentazione copre 14 moduli principali della piattaforma e consente agli utenti di creare applicazioni personalizzate, integrare sistemi esterni o testare le API manualmente con strumenti come Postman.
Come abilitare questo modulo
Per impostare il componente aggiuntivo API, puoi seguire questo collegamento: Add-On di configurazione.
Come utilizzare il componente aggiuntivo API?
Genera documenti API
Dopo aver acquistato e installato questo componente aggiuntivo, vai alla barra laterale della dashboard e cerca il componente aggiuntivo API Docs.
Per accedere alla documentazione API, vai alla sezione Documenti API dalla dashboard principale. La documentazione è organizzata da 14 moduli, semplificando la ricerca delle API specifiche necessarie per il tuo progetto di integrazione.
La sezione include un'introduzione generale che spiega come utilizzare le API in modo efficace. Questa panoramica copre i requisiti di autenticazione, le intestazioni comuni e le linee guida sull'utilizzo di base che si applicano a tutti gli endpoint API.
Ogni modulo contiene potenti elenchi API con dettagli tecnici completi. Per ogni endpoint API troverai il nome dell'API, l'URL esatto dell'endpoint, le intestazioni richieste per l'autenticazione e il formato dei dati, i parametri di input con i relativi tipi di dati e regole di convalida, risposte di esempio di successo che mostrano la struttura dei dati prevista ed esempi di risposte di errore con codici e messaggi di errore comuni.
Introduzione Gestione
Questa documentazione API completa è la tua porta d'accesso per sfruttare la potenza delle funzionalità di Mewayz, permettendoti di semplificare il tuo lavoro, aumentare la produttività e portare i tuoi progetti al livello successivo.
Questa documentazione API è una risorsa per gli sviluppatori, sia esperti che nuovi, che desiderano sfruttare le funzionalità di Mewayz all'interno delle loro applicazioni. Ecco cosa puoi aspettarti di trovare.
È possibile sfogliare il riferimento interattivo completo all'interno del prodotto di seguito Impostazioni → Documenti API.
La sezione endpoint copre GET per recuperare i dati, POST per creare nuovi dati, POST per aggiornare i dati esistenti e DELETE per rimuovere i dati. Puoi utilizzare metodi HTTP come GET per recuperare dati, POST per creare nuovi dati, POST per aggiornare i dati esistenti e DELETE per rimuovere dati.
I parametri della richiesta vengono utilizzati per personalizzare il comportamento delle richieste API e fornire dettagli più specifici quando si interagisce con l'API. Per Mewayz, potresti avere i seguenti tipi di parametri di richiesta: parametri di query per filtrare o ordinare i dati durante il recupero delle informazioni, intestazioni di richiesta per l'autenticazione e metadati aggiuntivi sulla richiesta e corpo della richiesta contenente dati JSON da creare o aggiornare.
L'API di Mewayz in genere risponde con dati in formato JSON. La risposta in genere include un codice di stato HTTP che indica l'esito della richiesta e i dati effettivi sono contenuti all'interno del file “dati” campo.
Gestione dell'autenticazione
Le API di autenticazione forniscono le funzionalità di accesso essenziali, funzionalità di aggiornamento dei token per il mantenimento delle sessioni e procedure di disconnessione per terminare in modo sicuro le sessioni degli utenti.
L'endpoint di accesso POST /api/login richiede intestazioni con “Accetta”: “application/json” e parametri tra cui e-mail come “[email protected]” e una password come **“john****”**.
Le risposte agli errori restituiscono 422 Unprocessable Content con “successo”: falso, “messaggio”: “Validazione Quando la validazione è un errore.
Le risposte agli errori restituiscono 400 Non autorizzato con “successo”: falso, “messaggio”: “Il fornito” quando le credenziali non sono valide.
Le risposte di accesso riuscite restituiscono 200 OK con “successo”: true e autorizzazione contenente token e tipo “portatore” per le successive chiamate API.
L'endpoint di aggiornamento di autenticazione POST /api/refresh utilizza intestazioni di autorizzazione con un token Bearer per la gestione della sessione.
Le risposte di aggiornamento riuscite restituiscono informazioni dettagliate sull'utente, inclusi 200 OK con “successo”: true e dettagli utente, ID, nome, email, mobile_no, tipo: “azienda”, avatar: "URL", lingua: “it” e gettone.
Gestione utenti
- API utente per l'amministrazione degli utenti, la gestione dei ruoli e i profili
operazioni.
Gestione del magazzino
- API di magazzino per la configurazione del magazzino e i trasferimenti di magazzino
gestione.
Gestione di prodotti e servizi
- Le API della sezione Prodotti e servizi gestiscono categorie di prodotti, tasse,
unità di misura, prodotti e gestione delle scorte con integrazione del magazzino.
Gestione fatture di acquisto
- API fatture d'acquisto per elenco fatture d'acquisto, creazione, dettaglio
Gestione aggiornamento, eliminazione, registrazione fatture.
Gestione resi acquisti
- API per la gestione dell'elenco dei resi di acquisto, della creazione, dei dettagli del reso,
Cancella, Approva, Completa l'elaborazione.
Gestione delle proposte di vendita
- API delle proposte di vendita per la gestione e la conversione delle proposte
processi.
Gestione fatture di vendita
- Le API delle fatture di vendita gestiscono l'elenco fatture, la creazione, l'aggiornamento, l'eliminazione
Gestione post fatture.
Gestione reso fatture di vendita
- API per la gestione dell'elenco resi delle fatture di vendita, creazione, dettaglio, eliminazione,
Approva e completa.
Gestione del conto
- Le API della sezione Account consentono di gestire Clienti, Fornitori,
- Il modulo Account include API di elenco rapido per il recupero semplice
Conti bancari, piano dei conti, entrate, spese, note di credito, note di debito, pagamenti fornitori, pagamenti clienti, transazioni bancarie, registrazioni di bonifici bancari. È possibile eseguire operazioni come elencare i record, creare nuove voci, visualizzare i dettagli, aggiornare le informazioni ed eliminare i record secondo necessità.
elenchi di clienti e fornitori, elenco conti GL, insieme a categorie di entrate e spese per selezioni a discesa e riferimenti rapidi.
Gestione del progetto
- Le API della sezione progetto gestiscono progetti, attività, bug, traguardi,
file e vari report con le fasi e i flussi di lavoro associati.
Gestione POS
- Le API POS gestiscono le operazioni del punto vendita, inclusa la gestione degli ordini
e dettagli dell'ordine.
Gestione CRM
- Le API della sezione CRM coprono la gestione della pipeline, le fasi di lead e deal,
etichette, fonti e gestione completa di Lead e Trattative. Puoi gestire attività, utenti, prodotti, fonti, email, discussioni, file e chiamate associate sia ai lead che alle trattative.
Gestione delle risorse umane
- Le API HRM gestiscono la gestione dei dipendenti, la struttura organizzativa,
monitoraggio delle presenze, gestione delle ferie, elaborazione delle buste paga e vari record delle risorse umane tra cui premi, promozioni, dimissioni, cessazioni, avvisi, reclami, trasferimenti di dipendenti, ferie, eventi, documenti, annunci e riconoscimenti.
Ogni endpoint API nella documentazione include esempi pratici che puoi copiare e utilizzare direttamente nel tuo ambiente di sviluppo o negli strumenti di test. Gli esempi di risposta mostrano sia operazioni riuscite che scenari di errore comuni, aiutandoti a implementare una corretta gestione degli errori nelle tue applicazioni.
Moduli Elenco API Wise:
- Autenticazione:
- Login
- Aggiornamento dei gettoni
- Esci
- Utente:
- Utente: Elenca, Crea, Aggiorna, Elimina,
- Ruolo : Elenco
- Registro utente: Elenco
- Utenti del personale: Elenco
- Utenti del cliente: Elenco
- Utenti del venditore: Elenco
- Magazzino:
Aggiornamento profilo, Aggiornamento password, Reimposta password, Verifica
- Magazzino: Elenca, Crea, Dettaglio, Aggiorna,
- Trasferimento: Elenco, Crea dati richiesta,
- Prodotto e servizio:
Elimina
Crea, Elimina
- Categoria prodotto: Elenca, crea, aggiorna,
- Tassa: Elenca, Crea, Aggiorna, Elimina
- Unità: Elenca, Crea, Aggiorna, Elimina
- Prodotto : Elenca, Crea, Dettaglio, Aggiorna,
- Stock di prodotti: Elenca, Aggiungi
- Prodotto di magazzino : Elenco
- Fattura d'acquisto:
Elimina
Elimina
- Fattura: Elenca, Crea, Dettaglio, Aggiorna,
- Reso acquisto:
Elimina, pubblica
- Ritorno: Elenca, Crea, Dettaglia, Elimina,
- Proposta di vendita:
Approvare, Completare
- Proposta: Elenca, Crea, Dettaglio, Aggiorna,
- Fattura di vendita:
Elimina, Inviato, Accetta, Rifiuta, Converti in fattura
- Fattura: Elenca, Crea, Dettaglio, Aggiorna,
- Restituzione fattura di vendita:
Elimina, pubblica
- Ritorno: Elenca, Crea, Dettaglia, Elimina,
- Conto:
Approvare, Completare
- Ottieni clienti: Elenco clienti semplice
- Ottieni venditori: Elenco fornitori semplice
- Cliente: Elenca, Crea, Aggiorna, Elimina
- Venditore: Elenca, Crea, Aggiorna, Elimina
- Conto GL: Elenco
- Conto bancario: Elenca, Crea, Aggiorna, Elimina
- Categorie di entrate: Elenco
- Fatturato : Elenca, Crea, Aggiorna, Elimina,
- Categorie di spesa: Elenco
- Spesa : Elenca, Crea, Aggiorna, Elimina,
- Tipi di conto: Elenco
- Piano dei conti: Elenco
- Transazione bancaria: Elenco
- Bonifico bancario: Elenco
- Pagamenti del venditore: Elenco
- Pagamenti del cliente: Elenco
- Nota di credito: Elenco
- Nota di addebito: Elenco
- Progetto:
Approva, pubblica
Approva, pubblica
- Progetto: Elenca, Crea, Dettaglio, Aggiorna,
- Membro del progetto: Elimina
- Cliente del progetto: Elenca, Invita, Elimina
- Traguardo del progetto: Elenca, crea, aggiorna,
- File di progetto: Crea, Elimina
- Compito: Scheda attività, Crea, Dettagli, Aggiorna,
- Commento all'attività: Crea, Elimina
- Attività secondaria dell'attività: Crea, aggiorna
- Stato del bug: Elenco
- Errore: Elenca, Crea, Dettaglia, Aggiorna, Elimina
- Commento sul bug: Crea, Elimina
- Rapporto sul progetto: Elenco, dettaglio
- Fase del compito: Elenca, Ordina, Crea, Aggiorna,
- Fase del bug: Elenca, Ordina, Crea, Aggiorna,
- POS:
Elimina
Elimina
Elimina
Elimina
Elimina
- Ordine: Elenco, dettaglio
- CRM:
- Pipeline: Elenca, Crea, Aggiorna, Elimina
- Fase principale: Elenca, Crea, Aggiorna, Elimina
- Fase dell'affare: Elenca, Crea, Aggiorna, Elimina
- Etichette: Elenca, Crea, Aggiorna, Elimina
- Fonti: Elenca, Crea, Aggiorna, Elimina
- Lead : Elenca, Crea, Dettaglio, Aggiorna,
- Compito principale: Crea, Aggiorna, Elimina
- Utente lead: Crea, Elimina
- Prodotto principale: Crea, Elimina
- Fonte principale: Crea, Elimina
- E-mail principale: Crea
- Discussione principale: Crea
- File principale: Crea, Elimina
- Chiamata principale: Crea, Aggiorna, Elimina
- Affare: Elenca, Crea, Dettaglio, Aggiorna,
- Compito dell'affare: Crea, Aggiorna, Elimina
- Utente dell'offerta: Crea, Elimina
- Prodotto in offerta: Crea, Elimina
- Fonte dell'offerta: Crea, Elimina
- E-mail dell'offerta: Crea
- Discussione sull'affare: Crea
- File dell'offerta: Crea, Elimina
- Cliente dell'affare: Crea, Elimina
- Chiamata per l'affare: Crea, Aggiorna, Elimina
- Gestione delle risorse umane:
Elimina, Aggiungi etichetta, Converti in trattativa
Elimina, aggiungi etichetta
- Dipendente: Elenca, Crea, Dettaglio, Aggiorna,
- Frequenza: Elenca, Crea, Aggiorna, Elimina
- Tipi di congedo: Elenco
- Lascia le applicazioni: Elenca, crea, aggiorna,
- Lascia i saldi: Controlla
- Libro paga: Elenco, dettaglio
- Busta paga: Genera
- Turni: Elenco
- Rami: Elenco
- Dipartimenti: Elenco
- Designazioni: Elenco
- Tipi di documenti: Elenco
- Giorni festivi: Elenco
- Premi: Elenco
- Promozioni: Elenco
- Dimissioni: Elenco
- Terminazioni: Elenco
- Avvertenze: Elenco
- Reclami: Elenco
- Trasferimenti dei dipendenti: Elenco
- Documenti: Elenco
- Ringraziamenti: Elenco
- Annunci: Elenco
- Eventi: Elenco
Elimina
Elimina, aggiorna stato