API v6
Build with the Hablame API
Guides to integrate Hablame’s services, what to expect from each response and what to do when something fails. Start with the seven-step walkthrough: in a few minutes you make your first request.
Getting started
From zero to your first response, and how to test without surprises.
Get started
A seven-step walkthrough to make your first request to the Hablame API v6: what to integrate, requirements, your API key, first response and support.
6 min read
Requirements
Requirements to use the Hablame API v6, product by product: active organization, service or permission on the API key, balance or plan and a defined currency.
4 min read
Your API key
What a Hablame API key looks like, who can create it in Cloud, its options (services, capabilities, expiry and allowed networks) and how to delete it.
5 min read
Testing without surprises
There is no isolated test environment in the Hablame API v6. What you can query at no cost, what is charged for real and how to test your integration carefully.
4 min read
Product guides
Complete processes, start to finish, and not just single requests.
URL Shortener
Hablame URL Shortener guide: create short links with aliases, in bulk or with an expiry, check their visits and restore the ones you delete.
9 min read
Storage
Hablame Storage guide: query what you store, usage, retention and price, list your files and request temporary download links.
7 min read
SMS
SMS with Hablame: sending over SMPP 3.4 with delivery receipts, and inbound SMS by webhook. How to request access.
3 min read
Webhooks
Hablame webhooks: how to receive inbound SMS for your short code, verify the signature and respond in time.
4 min read
Concepts
What every endpoint shares. Read them once and come back when you need them.
Authentication
Bearer scheme, API key format, lifecycle, rotation, best practices and what to do if a key is exposed in the Hablame API v6.
7 min read
Response envelope
The uniform { success, data | error, meta } shape of the Hablame API v6: fields, invariants and how to branch your client.
5 min read
Usage limits and 429 Too Many Requests
The usage limits of the Hablame API v6: two-layer model, RateLimit-* headers, Retry-After and how to retry without overloading the API.
6 min read
Caching
The X-Cache and X-Cache-TTL headers of the Hablame API v6: what HIT, MISS and BYPASS mean and what to expect today from each published endpoint.
3 min read
Idempotency
How to use the Idempotency-Key header in the Hablame API v6 to retry without duplicating or charging twice, and which endpoints honor it today.
5 min read
Help
When something does not go as you expected.
Documented today
22 endpoints in 5 groups. This list comes from the same source as the reference, so it cannot go stale.
Utilities
URL Shortener
- POST
/Create a short linkapi/ v6/ urlshortener/ links - POST
/Create short links in bulkapi/ v6/ urlshortener/ links/ batch - GET
/List short linksapi/ v6/ urlshortener/ links - GET
/List available domainsapi/ v6/ urlshortener/ domains - GET
/Get a short linkapi/ v6/ urlshortener/ links/ {domain}/ {code} - PATCH
/Update a short linkapi/ v6/ urlshortener/ links/ {domain}/ {code} - DELETE
/Delete a short linkapi/ v6/ urlshortener/ links/ {domain}/ {code} - POST
/Restore a deleted linkapi/ v6/ urlshortener/ links/ {domain}/ {code}/ restore - GET
/Link statisticsapi/ v6/ urlshortener/ links/ {domain}/ {code}/ stats - GET
/Organization overviewapi/ v6/ urlshortener/ overview - GET
/URL Shortener pricingapi/ v6/ urlshortener/ pricing
Storage
Organization
For your tools
The API specification for your editor, your client generator or your tester.