01
API keys
Create and label keys in the authenticated developer workspace. Validation uses a hash; protected reveal uses an encrypted server-side copy when available.
Developer platform / Email API
Send the email
your product
needs to send.
Trigger verification, onboarding, receipts, alerts, and account messages with an authenticated request. Use raw content or a saved HiheMAX Mail template.
POST /api/v1/send202 ACCEPTED
curl -X POST https://hihemaxmail.hdock.app/api/v1/send \
-H "X-API-Key: hm_your_key" \
-H "Content-Type: application/json" \
-d '{
"to": "customer@example.com",
"templateId": "template_id",
"variables": {
"name": "Ada",
"actionUrl": "https://example.com/start"
}
}'02
Template rendering
Reference an active template you own and supply values for its subject, text, or HTML variables.
03
Credit checks
Each accepted recipient costs one credit. Requests without enough credits return a payment-required response.
04
Accepted delivery
A valid send returns HTTP 202 with a generated message ID after the infrastructure accepts the request.
One endpoint. Two content paths.
Direct content
Provide to, subject, and either body or html.
Saved template
Provide to, templateId, and an optional variables object.
Authentication accepts either X-API-Key or a Bearer token containing the same API key.
| Method | Path | Purpose | Cost |
|---|---|---|---|
| POST | /api/v1/send | Send one direct or template message | 1 / accepted recipient |
| POST | /api/v1/send/batch | Send up to 100 messages | 1 / successful item |
| POST | /api/v1/verify/start | Start OTP or magic-link verification | 1 |
| POST | /api/v1/verify/check | Check an OTP code | Free |
| GET | /api/v1/verify/confirm | Complete a magic-link verification | Free |
| GET | /api/v1/me | Read key, balance and usage summary | Free |
| GET | /api/v1/usage | Read recent usage events | Free |
Create and label a key
Use a different server-side key for production, staging and each application so usage and revocation remain attributable.
Handle every failure class
Validate 400 responses, replace invalid 401 credentials, top up on 402, honour Retry-After on 429 and back off on provider failures.
Observe the result
Read creditsRemaining from metered responses and inspect GET /api/v1/usage or the dashboard before blaming transport.
Build against the contract