Requirements
What your organization and your API key need before you call each product. If something is missing, the API answers with an error that says which piece is missing.
4 min readReviewed on
For every product
- An active organization at Hablame. If it is not active, the API answers
ACCOUNT_NOT_ACTIVE. - A valid API key. It goes in the
Authorization:header of every request. Without it,Bearer AUTH_REQUIRED; if it is not recognized,AUTH_INVALID_KEY. How to get one. - That the IP you call from is allowed, if the key was created with a list of networks. Otherwise,
AUTH_IP_NOT_ALLOWED.
Product by product
| Product | What the key needs | What your organization needs |
|---|---|---|
| URL Shortener | The urlshortener service, which grants the whole URL shortener: listing and reading, and also creating, editing, deleting and restoring links. | Available balance, or an active URL Shortener plan. Also a defined currency and a price in that currency: without them the API answers 409. |
| Storage | The Storage service (storage), which grants the seven queries: summary, usage, retention, price, and viewing and downloading files. | Nothing else. |
| Your organization query | The directory capability, because the response includes personal data. | Nothing else. |
| Ping and country catalog | A valid key. | Nothing else. They are not charged. |
| SMS over SMPP 3.4 | It does not use an API key: it uses an SMPP username and password that support gives you. | The Hablame team creates the SMPP account. It asks for the fixed public IPs you connect from and a cost center that usage is attributed to. |
| Inbound SMS webhook | It does not use an API key: notices arrive signed with a secret that you get in Cloud. | A short code assigned to your organization and a public URL that responds with a 2xx code. The Hablame team registers the endpoint on request. |
If something is missing
| The API answers | What is missing |
|---|---|
403 AUTH_SERVICE_NOT_ALLOWED | The key does not have the endpoint’s service. Ask the owner of your organization for another key with that service: a key’s scope cannot be changed afterwards. |
403 AUTH_CAPABILITY_NOT_ALLOWED | The key does not have the account capability the endpoint requires (account or directory). It is granted when the key is created. |
402 | Your organization has no available balance for the operation, or no active billing account. Nothing is done and nothing is charged. |
409 URLSHORTENER_CURRENCY_UNDEFINED | Your organization has not chosen its currency yet. It is chosen only once and cannot be changed. |
409 URLSHORTENER_NOT_PRICED | There is no URL Shortener price in your organization’s currency. Retrying does not fix it: write to support. |
Each code is explained in the error catalog.
For technical questions, email developers@hablame.co. If you have a production incident, message us on WhatsApp at +57 319 660 0002, 24/7.