Sviluppatori · API REST

Continua a costruire
Mewayz.

Un'unica API REST per l'intero spazio di lavoro: CRM, vendite, fatturazione, contabilità, progetti, POS, risorse umane e altro ancora. 372 endpoint, JSON ovunque, autenticati con un token al portatore. Lo stesso riferimento sfogliabile si trova in-app sotto Impostazioni → Documenti API.

URL di base · app.mewayz.com/api Autentica · Gettone al portatore Formato · JSON Endpoint · 372

Autenticazione

Ogni richiesta è autenticata con un token al portatore. Generane uno nella tua dashboard qui sotto Impostazioni → Chiavi API - viene mostrato una volta, quindi copialo allora. Un token eredita i ruoli e le autorizzazioni dell'utente che lo ha creato e la maggior parte degli endpoint delle risorse richiedono anche che il modulo corrispondente sia abilitato sul tuo piano.

Intestazione dell'autorizzazione
# Passa il tuo token ad ogni richiesta arricciatura https://app.mewayz.com/api/leads \ -H "Autorizzazione: Portatore 12|aZ8f3a...d92c" \ -H "Accetta: application/json"

Preferisci autenticarti a livello di codice? POST /api/login con la tua email e password restituisce un token al portatore che puoi utilizzare allo stesso modo, e POST /api/refresh le ruota.

Avvio rapido

Crea un lead CRM in meno di un minuto. L'API funziona con gli stessi dati visualizzati nel prodotto: non esiste un livello di sincronizzazione separato.

POST /api/lead/crea
arricciatura -X POST https://app.mewayz.com/api/lead/create \ -H "Autorizzazione: Portatore 12|aZ8f3a..." \ -H "Tipo di contenuto: application/json" \ -H "Accetta: application/json" \ -D '{ "nome": "Ada Lovelace", "e-mail": "[email protected]" }'

Errori e codici di stato

Utilizziamo codici di stato HTTP convenzionali. I corpi degli errori includono un file leggibile dall'uomo messaggio puoi emergere direttamente.

200OK: richiesta riuscita
201Creato — risorsa creata
401Non autorizzato: token mancante o non valido
422Non elaborabile: convalida non riuscita
429Troppe richieste — hai raggiunto un limite di frequenza
500Errore del server: lo attiveremo stato

Limiti di tariffa

Il traffico API è limitato per mantenere la piattaforma veloce per tutti. Se superi il limite riceverai un HTTP429 risposta: fai marcia indietro e riprova. Il Riprova dopo l'intestazione ti dice quando puoi riprendere.

Autenticazione e sessione /api/login

Accedi, aggiorna o revoca il tuo token, recupera l'utente che ha effettuato l'accesso, modifica il profilo e leggi gli elenchi di utenti del personale/clienti/fornitori. (11 endpoint)

POST/api/cambia-password
OTTIENI/api/utente-cliente
ELIMINA/api/elimina-account
POST/api/modifica-profilo
POST/api/login
POST/api/logout
POST/api/aggiorna
OTTIENI/api/utente-staff
POST/api/upload-photos
OTTIENI/api/utente
OTTIENI/api/utente-fornitore

Chiavi API /api/v1/settings/api-keys

Elenca, crea e revoca i tuoi token di accesso personali: le stesse chiavi che generi in Impostazioni → Chiavi API. (3 endpoint)

OTTIENI/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
ELIMINA/api/v1/settings/api-keys/{id}

CRM: lead, trattative e pipeline /api/lead

CRUD completo su lead, trattative, pipeline, fasi, etichette e fonti, oltre alle relative attività, chiamate, file, note e prodotti. (79 endpoint)

ELIMINA/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}
ELIMINA/api/deal-client/{deal_id}/delete/{client_id}
POST/api/discussione-deal/store/{deal_id}
POST/api/deal-email/store/{deal_id}
POST/api/file-offerta/store/{deal_id}
ELIMINA/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
ELIMINA/api/deal-source/{deal_id}/delete/{source_id}
POST/api/deal-stage/create
ELIMINA/api/deal-stage/delete/{id}
POST/api/fase-deal/aggiornamento/{id}
OTTIENI/api/fasi-dell'affare
POST/api/deal-task/create
ELIMINA/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/utente-offerta/negozio/{deal_id}
ELIMINA/api/deal-user/{deal_id}/delete/{user_id}
POST/api/deal/add-label/{id}
POST/api/deal/assign-products/{deal_id}
POST/api/deal/crea
ELIMINA/api/deal/delete/{id}
OTTIENI/api/deal/show/{id}
POST/api/deal/aggiornamento/{id}
ELIMINA/api/deal/{deal_id}/products/{product_id}
OTTIENI/api/deals
POST/api/etichetta/crea
ELIMINA/api/etichetta/eliminazione/{id}
POST/api/etichetta/aggiornamento/{id}
OTTIENI/api/labels
ELIMINA/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}
ELIMINA/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
ELIMINA/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
ELIMINA/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
OTTIENI/api/fasi-lead
POST/api/lead-task/create
ELIMINA/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/utente-lead/negozio/{lead_id}
ELIMINA/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/aggiungi-etichetta/{id}
POST/api/lead/assign-products/{lead_id}
POST/api/lead/convert-to-deal/{id}
POST/api/lead/crea
ELIMINA/api/lead/elimina/{id}
OTTIENI/api/lead/get-request-data
OTTIENI/api/lead/get-users
POST/api/lead/casa
POST/api/lead/lead-create-aggiornamento
POST/api/lead/lead-delete
POST/api/lead/lead-details
POST/api/lead/lead-stage-create-update
POST/api/lead/lead-stage-update
POST/api/lead/lead-stages
POST/api/lead/leadboard
POST/api/lead/pipeline-create-update
OTTIENI/api/lead/pipeline
OTTIENI/api/lead/mostra/{id}
POST/api/lead/aggiornamento/{id}
ELIMINA/api/lead/{lead_id}/products/{product_id}
OTTIENI/api/lead
POST/api/pipeline/crea
ELIMINA/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
OTTIENI/api/pipeline
POST/api/origine/crea
ELIMINA/api/source/delete/{id}
POST/api/source/update/{id}
OTTIENI/api/fonti

Vendite /api/sales/ordini-vendita

Opportunità, preventivi, incontri, ordini di vendita e ricerche di magazzino. (23 endpoint)

OTTIENI/api/sales/RequestData
POST/api/sales/get-warehouse-products
OTTIENI/api/vendite/casa
ELIMINA/api/vendite/riunione/distruggi/{id}
POST/api/vendite/riunione/negozio
POST/api/vendite/riunione/aggiornamento/{id}
OTTIENI/api/vendite/riunioni
OTTIENI/api/sales/opportunities
ELIMINA/api/sales/opportunities/delete/{id}
POST/api/vendite/opportunità/aggiornamento/{id}
POST/api/vendite/opportunità/negozio
POST/api/sales/parent-records
OTTIENI/api/vendite/preventivi
ELIMINA/api/sales/quotes/distruggi/{id}
POST/api/vendite/preventivi/negozio
POST/api/vendite/quotazioni/aggiornamento/{id}
OTTIENI/api/vendite/preventivi/{id}
ELIMINA/api/sales/ordine-vendita/eliminazione/{id}
POST/api/sales/ordine-vendita/negozio
POST/api/sales/ordine-vendita/aggiornamento/{id}
OTTIENI/api/sales/ordini-vendita
OTTIENI/api/sales/ordini-vendita/{id}
OTTIENI/api/vendite/magazzini

Proposte di vendita /api/proposta-di-vendita

Redige, invia, accetta/rifiuta proposte e convertile in fatture. (9 endpoint)

OTTIENI/api/proposta-di-vendita
POST/api/sales-proposal/accept/{proposal_id}
POST/api/proposta-di-vendita/convertire-in-fattura/{proposal_id}
POST/api/proposta-di-vendita/crea
ELIMINA/api/proposta-di-vendita/elimina/{proposta_id}
POST/api/proposta-di-vendita/rifiuta/{proposta_id}
POST/api/sales-proposal/sent/{proposal_id}
OTTIENI/api/proposta-di-vendita/mostra/{proposta_id}
POST/api/proposta-di-vendita/update/{proposta_id}

Fatture di vendita /api/fattura-di-vendita

Elenca, crea, aggiorna, cancella e registra le fatture di vendita. (6 endpoint)

OTTIENI/api/fattura-di-vendita
POST/api/fattura-di-vendita/crea
ELIMINA/api/fattura-di-vendita/elimina/{id_fattura}
POST/api/fattura-di-vendita/post/{id_fattura}
OTTIENI/api/fattura-di-vendita/mostra/{id_fattura}
POST/api/fattura-di-vendita/update/{id_fattura}

Restituzioni fatture di vendita /api/restituzione-fattura-di-vendita

Creare, approvare e completare i resi delle fatture di vendita. (6 endpoint)

OTTIENI/api/restituzione-fattura-di-vendita
POST/api/sales-invoice-return/approve/{return_id}
POST/api/fattura-di-vendita-reso/completa/{return_id}
POST/api/reso-fattura-vendita/crea
ELIMINA/api/restituzione-fattura-di-vendita/eliminazione/{return_id}
OTTIENI/api/fattura-di-vendita-reso/mostra/{return_id}

Fatture di acquisto /api/fattura-d'acquisto

Elenca, crea, aggiorna, elimina e contabilizza le fatture di acquisto. (6 endpoint)

OTTIENI/api/fattura-d'acquisto
POST/api/fattura-d'acquisto/create
ELIMINA/api/fattura-di-acquisto/elimina/{id_fattura}
POST/api/fattura-di-acquisto/post/{id_fattura}
OTTIENI/api/fattura-di-acquisto/mostra/{id_fattura}
POST/api/fattura-di-acquisto/update/{id_fattura}

Resi di acquisto /api/acquisto-reso

Crea, approva e completa i resi di acquisto. (6 endpoint)

OTTIENI/api/acquisto-reso
POST/api/reso-acquisto/approve/{return_id}
POST/api/reso-acquisto/completo/{return_id}
POST/api/acquisto-reso/crea
ELIMINA/api/purchase-return/delete/{return_id}
OTTIENI/api/acquisto-reso/mostra/{return_id}

Contabilità /api/piano-dei-conti

Clienti, fornitori, conti bancari, piano dei conti, ricavi, spese, pagamenti, note di credito/debito e bonifici. (37 endpoint)

OTTIENI/api/account-types
OTTIENI/api/conti-bancari
POST/api/conti-bancari/crea
ELIMINA/api/conti-bancari/elimina/{id}
POST/api/bank-accounts/update/{id}
OTTIENI/api/transazioni-bancarie
OTTIENI/api/bonifici-bancari
OTTIENI/api/piano-dei-conti
OTTIENI/api/note-di-credito
OTTIENI/api/pagamenti-cliente
OTTIENI/api/clienti
POST/api/clienti/crea
ELIMINA/api/customers/delete/{id}
POST/api/clienti/aggiornamento/{id}
OTTIENI/api/note-di-debito
OTTIENI/api/expense-categories
OTTIENI/api/spese
POST/api/spese/approvare/{id}
POST/api/expenses/create
ELIMINA/api/spese/elimina/{id}
POST/api/spese/post/{id}
POST/api/spese/aggiornamento/{id}
OTTIENI/api/get-clients
OTTIENI/api/get-vendor
OTTIENI/api/gl-account
OTTIENI/api/categorie-entrate
OTTIENI/api/revenues
POST/api/revenues/approvare/{id}
POST/api/revenues/create
ELIMINA/api/revenues/delete/{id}
POST/api/ricavi/post/{id}
POST/api/revenues/update/{id}
OTTIENI/api/pagamenti-venditore
OTTIENI/api/venditori
POST/api/vendor/crea
ELIMINA/api/vendor/delete/{id}
POST/api/vendor/update/{id}

Prodotti e servizi /api/prodotti

Prodotti, categorie, tasse, unità e stock. (20 endpoint)

OTTIENI/api/prodotto-servizio/articoli
POST/api/prodotto-stock/aggiungi
OTTIENI/api/scorte-prodotto
OTTIENI/api/product/category
POST/api/product/category/create
ELIMINA/api/prodotto/categoria/eliminazione/{id}
POST/api/prodotto/categoria/aggiornamento/{id}
POST/api/product/create
ELIMINA/api/prodotto/eliminazione/{id}
OTTIENI/api/prodotto/dettaglio/{id}
POST/api/prodotto/aggiornamento/{id}
OTTIENI/api/prodotti
OTTIENI/api/tassa
POST/api/tassa/crea
ELIMINA/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/unità/crea
ELIMINA/api/unità/eliminazione/{id}
POST/api/unità/aggiornamento/{id}
OTTIENI/api/unità

Magazzino e inventario /api/magazzino

Magazzini e trasferimenti di scorte. (9 endpoint)

OTTIENI/api/trasferimento
POST/api/trasferimento/crea
ELIMINA/api/transfer/delete/{transfer_id}
OTTIENI/api/transfer/request-data
OTTIENI/api/magazzino
POST/api/magazzino/crea
ELIMINA/api/magazzino/delete/{warehouse_id}
OTTIENI/api/magazzino/prodotto/{warehouse_id}
POST/api/magazzino/aggiornamento/{warehouse_id}

Progetti, attività e bug /api/progetti

Progetti, traguardi, schede attività, attività, sottoattività, bug e report. (45 endpoint)

OTTIENI/api/bug-status-list
OTTIENI/api/get-progetti
POST/api/project/bug-stage/create
ELIMINA/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
OTTIENI/api/project/bug-stages
POST/api/project/bug/create/{project_id}
OTTIENI/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
ELIMINA/api/project/bug/{id}/comment/delete
OTTIENI/api/progetto/bug/{progetto_id}
ELIMINA/api/project/client/delete/{id}
POST/api/progetto/cliente/invito
OTTIENI/api/progetto/clienti
ELIMINA/api/progetto/delete/{id}
POST/api/progetto/file/crea
ELIMINA/api/progetto/file/delete/{id}
ELIMINA/api/project/member/delete/{id}
POST/api/progetto/milestone/crea
ELIMINA/api/project/milestone/delete/{id}
POST/api/progetto/milestone/update/{id}
OTTIENI/api/progetto/pietre miliari
OTTIENI/api/progetto/report/{id}
OTTIENI/api/project/reports
OTTIENI/api/progetto/mostra/{id}
POST/api/project/task-stage/create
ELIMINA/api/project/task-stage/delete/{id}
POST/api/project/task-stage/order
POST/api/project/task-stage/update/{id}
OTTIENI/api/progetto/task-stages
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
ELIMINA/api/project/task/comment/delete/{comment_id}
OTTIENI/api/progetto/attività/mostra/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
OTTIENI/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
ELIMINA/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
ELIMINA/api/project/{project_id}/task/delete/{task_id}
OTTIENI/api/progetti
POST/api/projects/create

Punto vendita /api/pos

Ordini POS e dettagli dell'ordine. (2 endpoint)

OTTIENI/api/pos
OTTIENI/api/pos/mostra/{id}

Banco di supporto /api/support-ticket/tickets

Ticket e risposte, domande frequenti e articoli della knowledge base. (16 endpoint)

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

Complessivamente /api/taskly/progetti

Progetti e attività complessi per il modulo di progetto leggero. (18 endpoint)

OTTIENI/api/taskly/casa
POST/api/taskly/progetto-attività
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/project-details
ELIMINA/api/taskly/project-file-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/project-list
POST/api/taskly/project-status-update
OTTIENI/api/taskly/progetti
OTTIENI/api/taskly/projects/{progetto}/tasks
POST/api/taskly/task-create-update
POST/api/taskly/task-delete
POST/api/taskly/task-details
POST/api/taskly/task-list
POST/api/taskly/task-stage-update
POST/api/taskly/taskboard
OTTIENI/api/taskly/users

Monitoraggio del tempo /api/add-tracker

Avvia e ferma i contatori del tempo. (3 endpoint)

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

Utenti e ruoli /api/utenti

Amministra gli utenti dell'area di lavoro e leggi i ruoli. (8 endpoint)

OTTIENI/api/ruoli
ELIMINA/api/user/delete/{id}
POST/api/utente/reimposta-password/{id}
POST/api/utente/negozio
POST/api/utente/aggiornamento/{id}
PUT/api/utente/verifica/{id}
OTTIENI/api/utenti
OTTIENI/api/users/log

Risorse umane e buste paga /api/dipendenti

Dipendenti, presenze, ferie, buste paga, oltre all'intero set di dati HR (filiali, reparti, festività, premi e altro). (44 endpoint)

OTTIENI/api/riconoscimenti
OTTIENI/api/annunci
POST/api/presenze/crea
ELIMINA/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
OTTIENI/api/attendances
OTTIENI/api/premi
OTTIENI/api/rami
OTTIENI/api/reclami
OTTIENI/api/dipartimenti
OTTIENI/api/designazioni
OTTIENI/api/document-types
OTTIENI/api/trasferimenti-dipendenti
POST/api/dipendente/crea
ELIMINA/api/dipendente/elimina/{id}
OTTIENI/api/employee/show/{id}
POST/api/dipendente/aggiornamento/{id}
OTTIENI/api/dipendenti
OTTIENI/api/eventi
OTTIENI/api/festività
OTTIENI/api/hrm-documenti
POST/api/hrm/cronologia-presenze
POST/api/hrm/ingresso-uscita
POST/api/hrm/events
OTTIENI/api/hrm/get-foglie
OTTIENI/api/hrm/get-leaves-types
OTTIENI/api/hrm/lista-vacanze
OTTIENI/api/hrm/casa
POST/api/hrm/richiesta di congedo
POST/api/lascia-applicazione/crea
ELIMINA/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
OTTIENI/api/lascia-applicazioni
OTTIENI/api/saldi-congedo
OTTIENI/api/leave-types
OTTIENI/api/buste paga
OTTIENI/api/paghe/{payroll_id}
OTTIENI/api/busta paga/{payroll_entry_id}
OTTIENI/api/promozioni
OTTIENI/api/dimissioni
OTTIENI/api/shift
OTTIENI/api/terminazioni
OTTIENI/api/avvisi

API di terze parti (v1) /api/v1/clienti

Una sezione stabile e con versione creata per strumenti senza codice come Zapier: clienti e fatture. (7 endpoint)

OTTIENI/api/v1/clienti
POST/api/v1/clienti
OTTIENI/api/v1/clienti/{id}
PUT/api/v1/clienti/{id}
OTTIENI/api/v1/fatture
POST/api/v1/fatture
OTTIENI/api/v1/fatture/{id}

Endpoint pubblici /api/pubblico/piani

Aiutanti non autenticati: il catalogo del piano pubblico e il widget incorporabile di acquisizione dei lead e il badge partner. (4 endpoint)

OTTIENI/api/badge/{token}
OTTIENI/api/pubblico/piani
POST/api/widget/lead
OTTIENI/api/widget/{token}

Piattaforma white label /api/wl/piani

Endpoint server-server utilizzati dalle istanze white label per la fatturazione e Stripe Connect (autenticati tramite token). (6 endpoint)

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

Endpoint di integrazione /api/microsofttodo

Endpoint helper per integrazioni connesse (Microsoft To Do, Vonage SMS, post di Facebook). (3 endpoint)

OTTIENI/api/facebookpost
OTTIENI/api/microsofttodo
OTTIENI/api/vonagesms

Più endpoint

Endpoint registrati aggiuntivi. (1 endpoint)

OTTIENI/api/agents/{agent}/commissioni-eccedenti