Développeurs · API REST

Construire sur
Mewayz.

Une seule API REST pour tout votre espace de travail — CRM, ventes, facturation, comptabilité, projets, POS, RH et plus encore. 372 endpoints, du JSON partout, authentifié par un jeton bearer. La même référence consultable est disponible dans l'application sous Paramètres → Docs API.

URL de base · app.mewayz.com/api Auth · Jeton Bearer Format · JSON Points de terminaison · 372

Authentification

Chaque requête est authentifiée avec un jeton bearer. Générez-en un dans votre tableau de bord sous Paramètres → Clés API — il s'affiche une seule fois, copiez-le donc à ce moment-là. Un jeton hérite des rôles et permissions de l'utilisateur qui l'a créé, et la plupart des endpoints de ressources exigent aussi que le module correspondant soit activé sur votre forfait.

En-tête d'autorisation
# Transmettez votre jeton à chaque requête curl https://app.mewayz.com/api/leads \ -H "Authorization: Bearer 12|aZ8f3a...d92c" \ -H "Accept: application/json"

Vous préférez vous authentifier par programmation ? POST /api/login avec votre e-mail et votre mot de passe renvoie un jeton bearer que vous pouvez utiliser de la même manière, et POST /api/refresh le fait pivoter.

Démarrage rapide

Créez un prospect CRM en moins d'une minute. L'API fonctionne sur les mêmes données que celles affichées dans le produit — il n'y a pas de couche de synchronisation distincte.

POST /api/lead/create
curl -X POST https://app.mewayz.com/api/lead/create \ -H "Authorization: Bearer 12|aZ8f3a..." \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Ada Lovelace", "email": "[email protected]" }'

Erreurs et codes de statut

Nous utilisons les codes de statut HTTP conventionnels. Les corps d'erreur incluent un message lisible par un humain message que vous pouvez faire remonter directement.

200OK — requête réussie
201Créé — ressource créée
401Non autorisé — jeton manquant ou invalide
422Non traitable — échec de la validation
429Trop de requêtes — vous avez atteint une limite de débit
500Erreur serveur — nous allons régler ça statut

Limites de débit

Le trafic API est limité en débit pour garder la plateforme rapide pour tout le monde. Si vous dépassez la limite, vous recevrez un HTTP 429 réponse — patientez puis réessayez. Le Retry-After l'en-tête vous indique quand vous pouvez reprendre.

Authentification et session /api/login

Connectez-vous, actualisez ou révoquez votre jeton, récupérez l'utilisateur connecté, modifiez le profil et consultez les listes d'utilisateurs personnel / clients / fournisseurs. (11 points de terminaison)

POST/api/change-password
GET/api/client-user
SUPPRIMER/api/delete-account
POST/api/edit-profile
POST/api/login
POST/api/logout
POST/api/refresh
GET/api/staff-user
POST/api/upload-photos
GET/api/user
GET/api/vendor-user

Clés API /api/v1/settings/api-keys

Listez, créez et révoquez vos jetons d'accès personnels — les mêmes clés que vous générez sous Paramètres → Clés API. (3 points de terminaison)

GET/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
SUPPRIMER/api/v1/settings/api-keys/{id}

CRM — prospects, affaires et pipeline /api/leads

Gestion CRUD complète des prospects, affaires, pipelines, étapes, libellés et sources, ainsi que de leurs tâches, appels, fichiers, notes et produits. (79 points de terminaison)

SUPPRIMER/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}
SUPPRIMER/api/deal-client/{deal_id}/delete/{client_id}
POST/api/deal-discussion/store/{deal_id}
POST/api/deal-email/store/{deal_id}
POST/api/deal-file/store/{deal_id}
SUPPRIMER/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
SUPPRIMER/api/deal-source/{deal_id}/delete/{source_id}
POST/api/deal-stage/create
SUPPRIMER/api/deal-stage/delete/{id}
POST/api/deal-stage/update/{id}
GET/api/deal-stages
POST/api/deal-task/create
SUPPRIMER/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/deal-user/store/{deal_id}
SUPPRIMER/api/deal-user/{deal_id}/delete/{user_id}
POST/api/deal/add-label/{id}
POST/api/deal/assign-products/{deal_id}
POST/api/deal/create
SUPPRIMER/api/deal/delete/{id}
GET/api/deal/show/{id}
POST/api/deal/update/{id}
SUPPRIMER/api/deal/{deal_id}/products/{product_id}
GET/api/deals
POST/api/label/create
SUPPRIMER/api/label/delete/{id}
POST/api/label/update/{id}
GET/api/labels
SUPPRIMER/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}
SUPPRIMER/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
SUPPRIMER/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
SUPPRIMER/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
GET/api/lead-stages
POST/api/lead-task/create
SUPPRIMER/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
SUPPRIMER/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/add-label/{id}
POST/api/lead/assign-products/{lead_id}
POST/api/lead/convert-to-deal/{id}
POST/api/lead/create
SUPPRIMER/api/lead/delete/{id}
GET/api/lead/get-request-data
GET/api/lead/get-users
POST/api/lead/home
POST/api/lead/lead-create-update
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
GET/api/lead/pipelines
GET/api/lead/show/{id}
POST/api/lead/update/{id}
SUPPRIMER/api/lead/{lead_id}/products/{product_id}
GET/api/leads
POST/api/pipeline/create
SUPPRIMER/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
GET/api/pipelines
POST/api/source/create
SUPPRIMER/api/source/delete/{id}
POST/api/source/update/{id}
GET/api/sources

Ventes /api/sales/sales-orders

Opportunités, devis, réunions, commandes de vente et recherches d'entrepôt. (23 points de terminaison)

GET/api/sales/RequestData
POST/api/sales/get-warehouse-products
GET/api/sales/home
SUPPRIMER/api/sales/meeting/destroy/{id}
POST/api/sales/meeting/store
POST/api/sales/meeting/update/{id}
GET/api/sales/meetings
GET/api/sales/opportunities
SUPPRIMER/api/sales/opportunities/delete/{id}
POST/api/sales/opportunities/update/{id}
POST/api/sales/opportunitity/store
POST/api/sales/parent-records
GET/api/sales/quotes
SUPPRIMER/api/sales/quotes/destroy/{id}
POST/api/sales/quotes/store
POST/api/sales/quotes/update/{id}
GET/api/sales/quotes/{id}
SUPPRIMER/api/sales/sales-order/delete/{id}
POST/api/sales/sales-order/store
POST/api/sales/sales-order/update/{id}
GET/api/sales/sales-orders
GET/api/sales/sales-orders/{id}
GET/api/sales/warehouses

Propositions commerciales /api/sales-proposal

Rédigez, envoyez, acceptez/refusez des propositions et convertissez-les en factures. (9 endpoints)

GET/api/sales-proposal
POST/api/sales-proposal/accept/{proposal_id}
POST/api/sales-proposal/convert-to-invoice/{proposal_id}
POST/api/sales-proposal/create
SUPPRIMER/api/sales-proposal/delete/{proposal_id}
POST/api/sales-proposal/reject/{proposal_id}
POST/api/sales-proposal/sent/{proposal_id}
GET/api/sales-proposal/show/{proposal_id}
POST/api/sales-proposal/update/{proposal_id}

Factures de vente /api/sales-invoice

Lister, créer, mettre à jour, supprimer et comptabiliser les factures de vente. (6 points de terminaison)

GET/api/sales-invoice
POST/api/sales-invoice/create
SUPPRIMER/api/sales-invoice/delete/{invoice_id}
POST/api/sales-invoice/post/{invoice_id}
GET/api/sales-invoice/show/{invoice_id}
POST/api/sales-invoice/update/{invoice_id}

Retours de factures de vente /api/sales-invoice-return

Créez, approuvez et finalisez les retours de factures de vente. (6 points de terminaison)

GET/api/sales-invoice-return
POST/api/sales-invoice-return/approve/{return_id}
POST/api/sales-invoice-return/complete/{return_id}
POST/api/sales-invoice-return/create
SUPPRIMER/api/sales-invoice-return/delete/{return_id}
GET/api/sales-invoice-return/show/{return_id}

Factures d’achat /api/purchase-invoice

Listez, créez, mettez à jour, supprimez et comptabilisez les factures d'achat. (6 points de terminaison)

GET/api/purchase-invoice
POST/api/purchase-invoice/create
SUPPRIMER/api/purchase-invoice/delete/{invoice_id}
POST/api/purchase-invoice/post/{invoice_id}
GET/api/purchase-invoice/show/{invoice_id}
POST/api/purchase-invoice/update/{invoice_id}

Retours d'achats /api/purchase-return

Créez, approuvez et finalisez les retours d'achat. (6 points de terminaison)

GET/api/purchase-return
POST/api/purchase-return/approve/{return_id}
POST/api/purchase-return/complete/{return_id}
POST/api/purchase-return/create
SUPPRIMER/api/purchase-return/delete/{return_id}
GET/api/purchase-return/show/{return_id}

Comptabilité /api/chart-of-accounts

Clients, fournisseurs, comptes bancaires, plan comptable, revenus, dépenses, paiements, avoirs/notes de débit et virements. (37 points de terminaison)

GET/api/account-types
GET/api/bank-accounts
POST/api/bank-accounts/create
SUPPRIMER/api/bank-accounts/delete/{id}
POST/api/bank-accounts/update/{id}
GET/api/bank-transactions
GET/api/bank-transfers
GET/api/chart-of-accounts
GET/api/credit-notes
GET/api/customer-payments
GET/api/customers
POST/api/customers/create
SUPPRIMER/api/customers/delete/{id}
POST/api/customers/update/{id}
GET/api/debit-notes
GET/api/expense-categories
GET/api/expenses
POST/api/expenses/approve/{id}
POST/api/expenses/create
SUPPRIMER/api/expenses/delete/{id}
POST/api/expenses/post/{id}
POST/api/expenses/update/{id}
GET/api/get-clients
GET/api/get-vendors
GET/api/gl-accounts
GET/api/revenue-categories
GET/api/revenues
POST/api/revenues/approve/{id}
POST/api/revenues/create
SUPPRIMER/api/revenues/delete/{id}
POST/api/revenues/post/{id}
POST/api/revenues/update/{id}
GET/api/vendor-payments
GET/api/vendors
POST/api/vendors/create
SUPPRIMER/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Produits et services /api/products

Produits, catégories, taxes, unités et stock. (20 points de terminaison)

GET/api/product-service/items
POST/api/product-stock/add
GET/api/product-stocks
GET/api/product/category
POST/api/product/category/create
SUPPRIMER/api/product/category/delete/{id}
POST/api/product/category/update/{id}
POST/api/product/create
SUPPRIMER/api/product/delete/{id}
GET/api/product/detail/{id}
POST/api/product/update/{id}
GET/api/products
GET/api/tax
POST/api/tax/create
SUPPRIMER/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/unit/create
SUPPRIMER/api/unit/delete/{id}
POST/api/unit/update/{id}
GET/api/units

Entrepôt et inventaire /api/warehouse

Entrepôts et transferts de stock. (9 endpoints)

GET/api/transfer
POST/api/transfer/create
SUPPRIMER/api/transfer/delete/{transfer_id}
GET/api/transfer/request-data
GET/api/warehouse
POST/api/warehouse/create
SUPPRIMER/api/warehouse/delete/{warehouse_id}
GET/api/warehouse/product/{warehouse_id}
POST/api/warehouse/update/{warehouse_id}

Projets, tâches et bugs /api/projects

Projets, jalons, tableaux de tâches, tâches, sous-tâches, bugs et rapports. (45 points de terminaison)

GET/api/bug-status-list
GET/api/get-projects
POST/api/project/bug-stage/create
SUPPRIMER/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
GET/api/project/bug-stages
POST/api/project/bug/create/{project_id}
GET/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
SUPPRIMER/api/project/bug/{id}/comment/delete
GET/api/project/bug/{project_id}
SUPPRIMER/api/project/client/delete/{id}
POST/api/project/client/invite
GET/api/project/clients
SUPPRIMER/api/project/delete/{id}
POST/api/project/file/create
SUPPRIMER/api/project/file/delete/{id}
SUPPRIMER/api/project/member/delete/{id}
POST/api/project/milestone/create
SUPPRIMER/api/project/milestone/delete/{id}
POST/api/project/milestone/update/{id}
GET/api/project/milestones
GET/api/project/report/{id}
GET/api/project/reports
GET/api/project/show/{id}
POST/api/project/task-stage/create
SUPPRIMER/api/project/task-stage/delete/{id}
POST/api/project/task-stage/order
POST/api/project/task-stage/update/{id}
GET/api/project/task-stages
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
SUPPRIMER/api/project/task/comment/delete/{comment_id}
GET/api/project/task/show/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
GET/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
SUPPRIMER/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
SUPPRIMER/api/project/{project_id}/task/delete/{task_id}
GET/api/projects
POST/api/projects/create

Point de vente /api/pos

Commandes POS et détail de commande. (2 points de terminaison)

GET/api/pos
GET/api/pos/show/{id}

Service d'assistance /api/support-ticket/tickets

Tickets et réponses, FAQ et articles de base de connaissances. (16 points de terminaison)

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

Taskly /api/taskly/projects

Projets et tâches Taskly pour le module de gestion de projet allégée. (18 points de terminaison)

GET/api/taskly/home
POST/api/taskly/project-activity
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/project-details
SUPPRIMER/api/taskly/project-file-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/project-list
POST/api/taskly/project-status-update
GET/api/taskly/projects
GET/api/taskly/projects/{project}/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
GET/api/taskly/users

Suivi du temps /api/add-tracker

Démarrez et arrêtez les chronomètres. (3 points de terminaison)

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

Utilisateurs et rôles /api/users

Administrez les utilisateurs de l'espace de travail et consultez les rôles. (8 points de terminaison)

GET/api/roles
SUPPRIMER/api/user/delete/{id}
POST/api/user/reset-password/{id}
POST/api/user/store
POST/api/user/update/{id}
PUT/api/user/verify/{id}
GET/api/users
GET/api/users/log

RH et paie /api/employees

Employés, présences, congés, paie, ainsi que l'ensemble complet du dossier RH (branches, départements, jours fériés, récompenses et plus). (44 points de terminaison)

GET/api/acknowledgments
GET/api/announcements
POST/api/attendance/create
SUPPRIMER/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
GET/api/attendances
GET/api/awards
GET/api/branches
GET/api/complaints
GET/api/departments
GET/api/designations
GET/api/document-types
GET/api/employee-transfers
POST/api/employee/create
SUPPRIMER/api/employee/delete/{id}
GET/api/employee/show/{id}
POST/api/employee/update/{id}
GET/api/employees
GET/api/events
GET/api/holidays
GET/api/hrm-documents
POST/api/hrm/attendence-history
POST/api/hrm/clock-in-out
POST/api/hrm/events
GET/api/hrm/get-leaves
GET/api/hrm/get-leaves-types
GET/api/hrm/holidays-list
GET/api/hrm/home
POST/api/hrm/leave-request
POST/api/leave-application/create
SUPPRIMER/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
GET/api/leave-applications
GET/api/leave-balances
GET/api/leave-types
GET/api/payrolls
GET/api/payrolls/{payroll_id}
GET/api/payslip/{payroll_entry_id}
GET/api/promotions
GET/api/resignations
GET/api/shifts
GET/api/terminations
GET/api/warnings

API tierce (v1) /api/v1/customers

Une couche stable et versionnée, conçue pour les outils no-code comme Zapier — clients et factures. (7 endpoints)

GET/api/v1/customers
POST/api/v1/customers
GET/api/v1/customers/{id}
PUT/api/v1/customers/{id}
GET/api/v1/invoices
POST/api/v1/invoices
GET/api/v1/invoices/{id}

Points de terminaison publics /api/public/plans

Assistants non authentifiés : le catalogue public des forfaits et le widget intégrable de capture de leads ainsi que le badge partenaire. (4 points de terminaison)

GET/api/badge/{token}
GET/api/public/plans
POST/api/widget/lead
GET/api/widget/{token}

Plateforme en marque blanche /api/wl/plans

Points de terminaison serveur à serveur utilisés par les instances en marque blanche pour la facturation et Stripe Connect (authentifiés par jeton). (6 points de terminaison)

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

Points de terminaison d'intégration /api/microsofttodo

Points de terminaison auxiliaires pour les intégrations connectées (Microsoft To Do, Vonage SMS, publications Facebook). (3 points de terminaison)

GET/api/facebookpost
GET/api/microsofttodo
GET/api/vonagesms

Plus de points de terminaison

Points de terminaison enregistrés supplémentaires. (1 points de terminaison)

GET/api/agents/{agent}/outstanding-commissions