Requisitos
Qué necesitan tu organización y tu clave de API antes de llamar a cada producto. Si algo falta, la API responde con un error que dice cuál es la pieza que falta.
4 min de lecturaRevisado el
Para todos los productos
- Una organización activa en Hablame. Si no está activa, la API responde
ACCOUNT_NOT_ACTIVE. - Una clave de API vigente. Va en la cabecera
Authorization:de cada petición. Sin ella,Bearer AUTH_REQUIRED; si no se reconoce,AUTH_INVALID_KEY. Cómo obtenerla. - Que la IP desde la que llamas esté permitida, si la clave se creó con una lista de redes. Si no,
AUTH_IP_NOT_ALLOWED.
Crea tu clave en Cloud
Entra a Cloud y abre «Claves API». Si todavía no tienes cuenta, regístrate.
Producto por producto
| Producto | Qué necesita la clave | Qué necesita tu organización |
|---|---|---|
| Acortador de URLs | El servicio urlshortener, que da todo el acortador: listar y consultar, y también crear, editar, eliminar y restaurar enlaces. | Para crear enlaces: saldo disponible, o un plan del acortador vigente. Además, una moneda definida y una tarifa en esa moneda: sin ellas la API responde 409. |
| Almacenamiento | El servicio Almacenamiento (storage), que da las siete consultas: resumen, consumo, conservación, tarifa, y ver y descargar archivos. | Nada más. |
| Consulta de tu organización | La capacidad directory, porque la respuesta incluye datos personales. | Nada más. |
| Ping y catálogo de países | Una clave válida. | Nada más. No cobran. |
| SMS por SMPP 3.4 | No usa clave de API: usa un usuario y una contraseña SMPP que entrega soporte. | La cuenta SMPP la crea el equipo de Hablame. Pide IP públicas fijas desde las que te conectas y un centro de costo al que se atribuye el consumo. |
| Webhook de SMS entrantes | No usa clave de API: los avisos llegan firmados con un secreto que obtienes en Cloud. | Un código corto asignado a tu organización y una URL pública que responda con un código 2xx. El equipo de Hablame registra el destino a pedido. |
Si falta algo
| La API responde | Qué falta |
|---|---|
403 AUTH_SERVICE_NOT_ALLOWED | La clave no tiene el servicio del endpoint. Pídele al propietario de tu organización otra clave con ese servicio: el alcance de una clave no se puede cambiar después. |
403 AUTH_CAPABILITY_NOT_ALLOWED | La clave no tiene la capacidad de la cuenta que pide el endpoint (account o directory). Se concede al crear la clave. |
402 | Tu organización no tiene saldo disponible para la operación, o no tiene una cuenta de facturación activa. No se hace nada ni se cobra. |
409 URLSHORTENER_CURRENCY_UNDEFINED | Tu organización todavía no eligió su moneda. Se elige una sola vez y no se puede cambiar. |
409 URLSHORTENER_NOT_PRICED | No hay tarifa del acortador en la moneda de tu organización. Reintentar no lo arregla: escribe a soporte. |
Cada código está explicado en el catálogo de errores.
Para dudas técnicas escribe a developers@hablame.co. Si tienes una incidencia en producción, escribe por WhatsApp al +57 319 660 0002, las 24 horas.