Udviklere · REST API

Bygg på
Mewayz.

Én REST API på tværs af hele dit arbejdsområde - CRM, salg, fakturering, regnskab, projekter, POS, HR og mere. 372 endepunkter, JSON overalt, godkendt med en bærer-token. Den samme reference, der kan gennemses, findes i appen under Indstillinger → API-dokumenter.

Basis URL · app.mewayz.com/api Auth · Bærertegn Format · JSON Slutpunkter · 372

Autentificering

Hver anmodning er autentificeret med en ihændehaver-token. Generer en i dit dashboard under Indstillinger → API-nøgler — den vises én gang, så kopier den derefter. Et token arver rollerne og tilladelserne for den bruger, der oprettede det, og de fleste ressourceslutpunkter kræver også, at det matchende modul er aktiveret på din plan.

Autorisationsoverskrift
# Giv dit token ved hver anmodning krølle https://app.mewayz.com/api/leads \ -H "Autorisation: Bearer 12|aZ8f3a...d92c" \ -H "Accepter: application/json"

Foretrækker du at godkende programmatisk? POST /api/login med din e-mail og adgangskode returnerer en ihændehaver token du kan bruge på samme måde, og POST /api/refresh drejer den.

Quickstart

Opret et CRM-emne på under et minut. API'en arbejder mod de samme data, som du ser i produktet - der er ikke noget separat synkroniseringslag.

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

Fejl og statuskoder

Vi bruger konventionelle HTTP-statuskoder. Fejllegemer omfatter en menneskelig læsbar besked du kan komme direkte til overfladen.

200OK — anmodningen lykkedes
201Oprettet — ressource oprettet
401Uautoriseret — manglende eller ugyldig token
422Kan ikke behandles – validering mislykkedes
429For mange anmodninger – du rammer en takstgrænse
500Serverfejl – vi har den tændt status

Satsgrænser

API-trafik er hastighedsbegrænset for at holde platformen hurtig for alle. Hvis du overskrider grænsen, modtager du en HTTP 429 svar — gå tilbage og prøv igen. Den Prøv igen - Efter header fortæller dig, hvornår du kan genoptage.

Autentificering og session /api/login

Log ind, opdater eller tilbagekald dit token, hent den loggede bruger, rediger profilen, og læs medarbejder-/klient-/leverandørbrugerlister. (11 endepunkter)

POST/api/skift adgangskode
FÅ/api/klient-bruger
SLET/api/slet-konto
POST/api/rediger-profil
POST/api/login
POST/api/logout
POST/api/refresh
FÅ/api/personale-bruger
POST/api/upload-fotos
FÅ/api/bruger
FÅ/api/vendor-user

API nøgler /api/v1/settings/api-keys

List, opret og tilbagekald dine personlige adgangstokens - de samme nøgler, som du genererer under Indstillinger → API-nøgler. (3 endepunkter)

FÅ/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
SLET/api/v1/settings/api-keys/{id}

CRM — kundeemner, aftaler og pipeline /api/leads

Fuld CRUD over kundeemner, aftaler, pipelines, faser, etiketter og kilder, plus deres opgaver, opkald, filer, noter og produkter. (79 endepunkter)

SLET/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}
SLET/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}
SLET/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
SLET/api/deal-source/{deal_id}/delete/{source_id}
POST/api/deal-stage/create
SLET/api/deal-stage/delete/{id}
POST/api/deal-stage/update/{id}
FÅ/api/deal-stages
POST/api/deal-task/create
SLET/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/deal-user/store/{deal_id}
SLET/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
SLET/api/deal/delete/{id}
FÅ/api/deal/show/{id}
POST/api/deal/update/{id}
SLET/api/deal/{deal_id}/products/{product_id}
FÅ/api/deals
POST/api/label/create
SLET/api/label/delete/{id}
POST/api/label/update/{id}
FÅ/api/labels
SLET/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}
SLET/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
SLET/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
SLET/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
FÅ/api/lead-stages
POST/api/lead-task/create
SLET/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
SLET/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
SLET/api/lead/delete/{id}
FÅ/api/lead/get-request-data
FÅ/api/lead/get-users
POST/api/lead/home
POST/api/lead/lead-create-update
POST/api/lead/lead-delete
POST/api/lead/lead-detaljer
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
FÅ/api/lead/pipelines
FÅ/api/lead/show/{id}
POST/api/lead/update/{id}
SLET/api/lead/{lead_id}/products/{product_id}
FÅ/api/leads
POST/api/pipeline/create
SLET/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
FÅ/api/pipelines
POST/api/source/create
SLET/api/source/delete/{id}
POST/api/source/update/{id}
FÅ/api/kilder

Salg /api/salg/salgsordrer

Muligheder, tilbud, møder, salgsordrer og lageropslag. (23 endepunkter)

FÅ/api/salg/RequestData
POST/api/salg/get-varehus-produkter
FÅ/api/salg/hjem
SLET/api/sales/meeting/destroy/{id}
POST/api/salg/møde/butik
POST/api/sales/meeting/update/{id}
FÅ/api/salg/møder
FÅ/api/salg/muligheder
SLET/api/sales/opportunities/delete/{id}
POST/api/sales/opportunities/update/{id}
POST/api/sales/opportunity/store
POST/api/sales/parent-records
FÅ/api/salg/quotes
SLET/api/sales/quotes/destroy/{id}
POST/api/salg/quotes/butik
POST/api/sales/quotes/update/{id}
FÅ/api/sales/quotes/{id}
SLET/api/sales/sales-order/delete/{id}
POST/api/salg/salgsordre/butik
POST/api/sales/sales-order/update/{id}
FÅ/api/salg/salgsordrer
FÅ/api/sales/sales-orders/{id}
FÅ/api/salg/varehuse

Salgsforslag /api/salgsforslag

Udarbejde, sende, acceptere/afvise forslag og konvertere dem til fakturaer. (9 endepunkter)

FÅ/api/salgsforslag
POST/api/sales-proposal/accept/{proposal_id}
POST/api/sales-proposal/convert-to-invoice/{proposal_id}
POST/api/sales-proposal/create
SLET/api/sales-proposal/delete/{proposal_id}
POST/api/sales-proposal/reject/{proposal_id}
POST/api/sales-proposal/sent/{proposal_id}
FÅ/api/sales-proposal/show/{proposal_id}
POST/api/sales-proposal/update/{proposal_id}

Salgsfakturaer /api/salgsfaktura

Liste, oprette, opdatere, slette og bogføre salgsfakturaer. (6 endepunkter)

FÅ/api/salgsfaktura
POST/api/sales-invoice/create
SLET/api/sales-invoice/delete/{invoice_id}
POST/api/sales-invoice/post/{invoice_id}
FÅ/api/sales-invoice/show/{invoice_id}
POST/api/sales-invoice/update/{invoice_id}

Returnering af salgsfakturaer /api/salgsfaktura-retur

Opret, godkend og udfyld salgsfaktura returer. (6 endepunkter)

FÅ/api/salgsfaktura-retur
POST/api/sales-invoice-return/approve/{return_id}
POST/api/sales-invoice-return/complete/{return_id}
POST/api/sales-invoice-return/create
SLET/api/sales-invoice-return/delete/{return_id}
FÅ/api/sales-invoice-return/show/{return_id}

Købsfakturaer /api/købsfaktura

Liste, oprette, opdatere, slette og bogføre købsfakturaer. (6 endepunkter)

FÅ/api/købsfaktura
POST/api/købsfaktura/opret
SLET/api/purchase-invoice/delete/{invoice_id}
POST/api/purchase-invoice/post/{invoice_id}
FÅ/api/purchase-invoice/show/{invoice_id}
POST/api/purchase-invoice/update/{invoice_id}

Køb returnerer /api/køb-retur

Opret, godkend og gennemfør købsretur. (6 endepunkter)

FÅ/api/køb-retur
POST/api/purchase-return/approve/{return_id}
POST/api/purchase-return/complete/{return_id}
POST/api/purchase-return/create
SLET/api/purchase-return/delete/{return_id}
FÅ/api/purchase-return/show/{return_id}

Regnskab /api/kontoplan

Kunder, leverandører, bankkonti, kontoplan, indtægter, udgifter, betalinger, kredit-/debetnotaer og overførsler. (37 endepunkter)

FÅ/api/kontotyper
FÅ/api/bank-konti
POST/api/bank-konti/opret
SLET/api/bank-accounts/delete/{id}
POST/api/bank-accounts/update/{id}
FÅ/api/bank-transaktioner
FÅ/api/bankoverførsler
FÅ/api/kontoplan
FÅ/api/kreditnoter
FÅ/api/kunde-betalinger
FÅ/api/kunder
POST/api/customers/create
SLET/api/customers/delete/{id}
POST/api/customers/update/{id}
FÅ/api/debet-sedler
FÅ/api/udgiftskategorier
FÅ/api/udgifter
POST/api/expenses/approve/{id}
POST/api/udgifter/skabe
SLET/api/expenses/delete/{id}
POST/api/expenses/post/{id}
POST/api/expenses/update/{id}
FÅ/api/get-klienter
FÅ/api/get-leverandører
FÅ/api/gl-konti
FÅ/api/indtægtskategorier
FÅ/api/indtægter
POST/api/revenues/approve/{id}
POST/api/revenues/create
SLET/api/revenues/delete/{id}
POST/api/revenues/post/{id}
POST/api/revenues/update/{id}
FÅ/api/leverandør-betalinger
FÅ/api/leverandører
POST/api/vendors/create
SLET/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Produkter og tjenester /api/produkter

Produkter, kategorier, afgifter, enheder og lager. (20 endepunkter)

FÅ/api/product-service/items
POST/api/product-stock/add
FÅ/api/produkt-aktier
FÅ/api/produkt/kategori
POST/api/product/category/create
SLET/api/product/category/delete/{id}
POST/api/product/category/update/{id}
POST/api/product/create
SLET/api/product/delete/{id}
FÅ/api/product/detail/{id}
POST/api/product/update/{id}
FÅ/api/produkter
FÅ/api/skat
POST/api/tax/create
SLET/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/unit/create
SLET/api/unit/delete/{id}
POST/api/unit/update/{id}
FÅ/api/enheder

Lager & inventar /api/lager

Lager og lageroverførsler. (9 endepunkter)

FÅ/api/overførsel
POST/api/transfer/create
SLET/api/transfer/delete/{transfer_id}
FÅ/api/transfer/request-data
FÅ/api/lager
POST/api/warehouse/create
SLET/api/warehouse/delete/{warehouse_id}
FÅ/api/warehouse/product/{warehouse_id}
POST/api/warehouse/update/{warehouse_id}

Projekter, opgaver og fejl /api/projekter

Projekter, milepæle, opgavetavler, opgaver, delopgaver, fejl og rapporter. (45 endepunkter)

FÅ/api/bug-status-list
FÅ/api/get-projects
POST/api/project/bug-stage/create
SLET/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
FÅ/api/project/bug-stages
POST/api/project/bug/create/{project_id}
FÅ/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
SLET/api/project/bug/{id}/comment/delete
FÅ/api/project/bug/{project_id}
SLET/api/project/client/delete/{id}
POST/api/project/client/invite
FÅ/api/project/klienter
SLET/api/project/delete/{id}
POST/api/project/file/create
SLET/api/project/file/delete/{id}
SLET/api/project/member/delete/{id}
POST/api/project/milestone/create
SLET/api/project/milestone/delete/{id}
POST/api/project/milestone/update/{id}
FÅ/api/project/milepæle
FÅ/api/project/report/{id}
FÅ/api/project/rapporter
FÅ/api/project/show/{id}
POST/api/project/task-stage/create
SLET/api/project/task-stage/delete/{id}
POST/api/project/task-stage/order
POST/api/project/task-stage/update/{id}
FÅ/api/project/task-stages
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
SLET/api/project/task/comment/delete/{comment_id}
FÅ/api/project/task/show/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
FÅ/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
SLET/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
SLET/api/project/{project_id}/task/delete/{task_id}
FÅ/api/projekter
POST/api/projects/create

Salgssted /api/pos

POS-ordrer og ordredetaljer. (2 endepunkter)

FÅ/api/pos
FÅ/api/pos/show/{id}

Support skrivebord /api/support-ticket/tickets

Billetter og svar, ofte stillede spørgsmål og videnbaserede artikler. (16 endepunkter)

POST/api/support-ticket/faq/delete/{faq_id}
POST/api/support-ticket/faq/update/{faq_id}
FÅ/api/support-ticket/faqs
POST/api/support-ticket/faqs/store
FÅ/api/support-ticket/get-request-data
FÅ/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}
FÅ/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/butik
POST/api/support-ticket/ticket/update/{ticket_id}
FÅ/api/support-ticket/tickets

Taskly /api/taskly/projects

Taskly-projekter og opgaver til letvægtsprojektmodulet. (18 endepunkter)

FÅ/api/taskly/home
POST/api/taskly/project-activity
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/project-details
SLET/api/taskly/project-file-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/project-list
POST/api/taskly/project-status-update
FÅ/api/taskly/projects
FÅ/api/taskly/projects/{project}/opgaver
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
FÅ/api/taskly/brugere

Tidsregistrering /api/add-tracker

Start og stop tidsregistrering. (3 endepunkter)

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

Brugere og roller /api/brugere

Administrer arbejdsområdebrugere og læs roller. (8 endepunkter)

FÅ/api/roller
SLET/api/user/delete/{id}
POST/api/bruger/reset-password/{id}
POST/api/bruger/butik
POST/api/bruger/update/{id}
SÆT/api/user/verify/{id}
FÅ/api/brugere
FÅ/api/brugere/log

HR & løn /api/medarbejdere

Medarbejdere, tilstedeværelse, orlov, løn, plus det fulde HR-rekordsæt (filialer, afdelinger, ferier, priser og mere). (44 endepunkter)

FÅ/api/anerkendelser
FÅ/api/meddelelser
POST/api/attendance/create
SLET/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
FÅ/api/deltagelser
FÅ/api/awards
FÅ/api/grene
FÅ/api/klager
FÅ/api/afdelinger
FÅ/api/betegnelser
FÅ/api/dokumenttyper
FÅ/api/medarbejderoverførsler
POST/api/medarbejder/opret
SLET/api/employee/delete/{id}
FÅ/api/employee/show/{id}
POST/api/employee/update/{id}
FÅ/api/medarbejdere
FÅ/api/begivenheder
FÅ/api/ferier
FÅ/api/hrm-dokumenter
POST/api/hrm/attendence-history
POST/api/hrm/clock-in-out
POST/api/hrm/begivenheder
FÅ/api/hrm/get-leaves
FÅ/api/hrm/get-leaves-types
FÅ/api/hrm/ferie-liste
FÅ/api/hrm/home
POST/api/hrm/leave-request
POST/api/leave-application/create
SLET/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
FÅ/api/leave-applikationer
FÅ/api/leave-balances
FÅ/api/leave-typer
FÅ/api/lønslister
FÅ/api/payrolls/{payroll_id}
FÅ/api/payslip/{payroll_entry_id}
FÅ/api/kampagner
FÅ/api/opsigelser
FÅ/api/skifter
FÅ/api/terminations
FÅ/api/advarsler

Tredjeparts API (v1) /api/v1/kunder

En stabil version med versioner bygget til kodefri værktøjer som Zapier - kunder og fakturaer. (7 endepunkter)

FÅ/api/v1/kunder
POST/api/v1/kunder
FÅ/api/v1/customers/{id}
SÆT/api/v1/customers/{id}
FÅ/api/v1/fakturaer
POST/api/v1/fakturaer
FÅ/api/v1/invoices/{id}

Offentlige endepunkter /api/public/plans

Uautentificerede hjælpere: det offentlige plankatalog og den indlejrbare lead-capture-widget og partner-badge. (4 endepunkter)

FÅ/api/badge/{token}
FÅ/api/public/plans
POST/api/widget/lead
FÅ/api/widget/{token}

White-label platform /api/wl/planer

Server-til-server-slutpunkter, der bruges af white-label-instanser til fakturering og Stripe Connect (token-godkendt). (6 endepunkter)

POST/api/wl/checkout
POST/api/wl/connect/onboard
FÅ/api/wl/connect/status
FÅ/api/wl/planer
POST/api/wl/subscription/{stripe_subscription_id}/cancel
POST/api/wl/webhook-tilbagekald

Integrationsslutpunkter /api/microsofttodo

Hjælpeendepunkter til tilsluttede integrationer (Microsoft To Do, Vonage SMS, Facebook-indlæg). (3 endepunkter)

FÅ/api/facebookpost
FÅ/api/microsofttodo
FÅ/api/vonagesms

Flere endepunkter

Yderligere registrerede endepunkter. (1 endepunkter)

FÅ/api/agents/{agent}/outstanding-commissions