niiko/developers

Miira · leads y WhatsApp v1 solo lectura

miira.catalog_search

Busca en el catálogo publicado por palabras y devuelve hasta 5 ofertas activas y públicas con nombre, resumen, precio, moneda y por qué se cobra; si solo coincide una, también su descripción completa y sus atributos. Lo interno, lo pausado y lo descontinuado nunca vuelven.

Última actualización

POST /api/v1/reads/miira.catalog_search
Alcance del token
miira.catalog_search@1
Permiso del workspace
api.miira.catalog_search apagado por defecto
Quién lee
La persona detrás del token, con su rol. Quien deja el workspace deja de leer.
Tres permisos

Un token con ese alcance, que el dueño del workspace haya encendido la lectura, y que el rol de la persona la vea en el producto. Ninguna basta sola. Solo con OAuth →

Petición

campotiporeglas
querystringopcionalmax 200

Respuesta — output cuando status es done

campotiporeglas
foundbooleanobligatorio
offeringsobject[]obligatorio
detailobject | nullobligatorio

offerings[]

campotiporeglas
namestringobligatorio
summarystringobligatorio
pricestring | nullobligatorio
currencystring | nullobligatorio
unit"month" | "project" | "hour" | "unit" | "page" | nullobligatorio

detail

campotiporeglas
descriptionstring | nullobligatorio
attributesmap<string, string>obligatorio

Ejemplo

# Reads take an OAuth access token, not an API key, and no idempotency key: reading changes nothing.
curl -X POST https://niiko.org/api/v1/reads/miira.catalog_search \
  -H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
# 200 → done · 4xx → refused, with a named reason

Por qué puede negarse

Cada motivo dice quién puede arreglarlo y cómo; detail.message, cuando viene, dice qué hacer. Negativas y códigos HTTP →

invalid_inputrole_forbiddengrant_offreads_need_a_person

En los clientes

@vorluno/niiko-sdkniiko.searchCatalog()
niiko (Python)niiko.search_catalog() desde 0.4.0 · aún no está en el registro
niiko-cliniiko read miira.catalog_search
n8n-nodes-niikoSin lecturas: el nodo lleva una llave, y leer pide una persona por OAuth.
niiko-mcp-servermiira_catalog_search readOnlyHint

Historial