Tus datos de compromiso, en tus propias herramientas

Un encabezado, una clave

Crea una clave en Configuración → API. La clave completa se muestra una sola vez, al crearla. Nosotros guardamos un hash SHA-256 de ella, así que si se pierde el único camino es revocarla y generar una nueva.

# Cada solicitud lleva la clave como bearer token.
curl https://app.bloomder.io/api/v1/surveys \
  -H "Authorization: Bearer blm_live_YOUR_KEY_HERE"

Qué puede y qué no puede hacer una clave

• Está limitada a la organización que la creó. No existe una clave entre organizaciones.
• Es de solo lectura. La API no tiene ningún endpoint de escritura, así que una clave filtrada no puede alterar, borrar ni enviar nada.
• Puede revocarse en cualquier momento por el dueño de la cuenta, con efecto en la siguiente solicitud.
• Opcionalmente puede configurarse para expirar después de cierto número de días. Si se deja en blanco, la clave no expira — una expiración silenciosa rompería el trabajo nocturno de un cliente meses después de haberla configurado.

Cursores, no números de página

Los endpoints de listado devuelven una página de data y un next_cursor. Pasa ese cursor de vuelta para obtener la siguiente página; null significa que llegaste al final. Los cursores son estables ante inserciones, algo que la paginación por offset no es — una encuesta creada a mitad del recorrido no puede hacer que te saltes o repitas una fila.

# Primera página: 50 encuestas.
curl "https://app.bloomder.io/api/v1/surveys?limit=50" \
  -H "Authorization: Bearer $BLOOMDER_KEY"

# Respuesta
{
  "data": [ { "id": "clx…", "name": "Q3 Pulse", "status": "ACTIVE", … } ],
  "next_cursor": "clx8f2k…"
}

# Siguiente página.
curl "https://app.bloomder.io/api/v1/surveys?limit=50&cursor=clx8f2k…" \
  -H "Authorization: Bearer $BLOOMDER_KEY"

limit tiene un valor por defecto de 25 y un tope de 100. Un valor mayor se recorta, no se rechaza.

120 solicitudes por minuto, por clave

El presupuesto es por clave, no por organización ni por IP: tu integración corre desde donde sea que esté tu infraestructura, y dos claves en una misma cuenta no deberían competir por el mismo límite.

• X-RateLimit-Limit y X-RateLimit-Window vienen en cada respuesta, no solo en un 429, así que un cliente puede regular su ritmo antes de que lo rechacen.
• En un 429, Retry-After indica los segundos que hay que esperar. Respétalo en lugar de reintentar de inmediato.
• ¿Necesitas más para una recarga masiva? Escribe a [email protected] y cuéntanos la forma del trabajo.

Todos los endpoints, en una tabla

Todas las rutas son relativas a https://app.bloomder.io/api/v1. No hay endpoints de escritura.

Un ejemplo completo

Obtén los resultados más recientes de cada encuesta activa — la forma que toman la mayoría de las actualizaciones de BI.

#!/usr/bin/env bash
# Requiere: curl, jq. Define BLOOMDER_KEY en tu entorno.
set -euo pipefail
BASE="https://app.bloomder.io/api/v1"
AUTH=(-H "Authorization: Bearer $BLOOMDER_KEY")

curl -s "$BASE/surveys?limit=100" "${AUTH[@]}" \
  | jq -r '.data[] | select(.status == "ACTIVE") | .id' \
  | while read -r id; do
      curl -s "$BASE/surveys/$id/results" "${AUTH[@]}" \
        | jq '{survey: .survey_name, rate: .run.response_rate, suppressed, nps: .nps_score}'
    done