Saltar al contenido

Empieza aquí

Siete pasos para pasar de cero a tu primera respuesta de la API: qué puedes integrar, qué necesitas, cómo obtener tu clave, cómo hacer la primera petición y a quién acudir si algo falla.

6 min de lecturaRevisado el

  1. 01
    1. Descubre qué puedes integrar

    Los productos que hoy puedes usar desde la API.

  2. 02
    2. Revisa los requisitos

    Lo que tu organización necesita antes de llamar.

  3. 03
    3. Obtén tu clave de API

    La credencial que identifica a tu organización.

  4. 04
    4. Haz tu primera petición

    Una llamada que no cuesta nada y confirma que todo está conectado.

  5. 05
    5. Lee la respuesta

    La forma común de todas las respuestas y el número que debes citar a soporte.

  6. 06
    6. Integra un producto

    Guías completas, de principio a fin.

  7. 07
    7. Si algo falla

    Errores, resolución de problemas y soporte.

1. Descubre qué puedes integrar

Esto es lo que hoy está abierto. Cada tarjeta lleva a una guía que te explica el producto de principio a fin.

Además hay dos consultas generales, el ping para comprobar tu conexión y el catálogo de países, y la consulta de tu organización. Todo está en la referencia.

2. Revisa los requisitos

En resumen necesitas una organización activa de Hablame, el servicio o el permiso del producto que vas a usar y, si el producto cobra, saldo o un plan. La página de requisitos lo detalla producto por producto.

3. Obtén tu clave de API

Tu clave de API es una cadena que empieza por hk_. Identifica a tu organización en cada petición y se muestra completa una sola vez, al crearla: guárdala en un gestor de secretos. Cómo crearla y qué permisos darle.

Crea tu clave en Cloud

Entra a Cloud y abre «Claves API». Si todavía no tienes cuenta, regístrate.

Trata la clave como una contraseña. No la subas a un repositorio, no la pegues en un chat y no la pongas en una URL.

4. Haz tu primera petición

El endpoint GET /api/v6/utilities/ping es el más simple: comprueba que tu clave sirve y no cobra nada. Un 200 significa que tu conexión está lista para llamar al resto.

curl -H 'Authorization: Bearer hk_TU_API_KEY' \
  https://developers.hablame.co/api/v6/utilities/ping

Una llamada correcta devuelve HTTP 200 y un cuerpo como este. Los valores son de ejemplo:

respuesta
{
  "success": true,
  "data": {
    "pong": true,
    "apiVersion": "v6",
    "client": { "ip": "203.0.113.45" }
  },
  "meta": {
    "requestId": "b9b1704baffab211",
    "clientIp": "203.0.113.45",
    "timestamp": "2026-06-04T19:43:59+00:00",
    "responseTimeMs": 4.24
  }
}

El ping no devuelve los datos de tu organización. Para verlos usa GET /api/v6/account/organization, que además pide el permiso directory en la clave.

5. Lee la respuesta

Toda respuesta, buena o mala, viene en la misma estructura: { success, data | error, meta }. Revisa primero success; nunca decidas solo por el código HTTP. La envoltura de respuesta explica cada campo.

Guarda el meta.requestId de cada respuesta (también llega en la cabecera X-Request-Id). Si algo falla y escribes a soporte, con ese número encontramos tu petición exacta.

6. Integra un producto

Cada guía de producto sigue los mismos diez apartados, del objetivo a los próximos pasos, para que puedas completar un proceso entero y no solo una petición suelta.

Antes de pasar a producción lee cómo probar sin sorpresas: no hay un entorno aparte para pruebas y lo que se cobra, se cobra de verdad.

7. Si algo falla

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.

¿Necesitas ayuda?

¿Te sirvió esta página?

Ver todos los canales de soporte