The REST API is a paid add-on. Switch on REST API and webhooks in Settings → Modules, then open Settings → API and webhooks. Only Admins see it.
API tokens
- Click New token and name it after what will use it.
- For each area, choose None, Read or Read and write. Tokens can never reach company settings, users or payroll.
- Copy the token straight away. It's shown only once.
Send it as Authorization: Bearer <token> with each request. Each token has its own limit of requests a minute, and you can see how much each one is used. Revoke a token and it stops working immediately.
Webhooks
Add the address of the other system and choose the events, like An invoice is issued or A payment is recorded. MSMEPulse posts a short message saying what happened and to which record; the other system can then fetch the details with the API.
Each message carries an X-MSMEPulse-Signature header: an HMAC-SHA256 of the timestamp and body using the webhook's secret, so the receiver can check it really came from you. If a delivery fails, it's tried again after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours. The Webhook log shows every delivery, and Send again resends any of them.
API reference
API reference lists every endpoint, built from MSMEPulse itself so it's always current. Amounts are in paise or cents.