Herramientas

La consola#

La consola está en app.flavoso.com/es/developers. Solo necesitas una cuenta de Flavoso; no hace falta un negocio ni una suscripción. Cada app tiene estas secciones:

Al lado están el negocio de prueba con sus herramientas, común a todas tus apps, y la configuración mientras no esté terminada.

Registro de solicitudes#

Cada solicitud de tu app que lleve un token válido se conserva 14 días en el registro: hora, negocio, método, ruta, operación (operationId), parámetros de consulta, estado, duración, X-Request-Id, código de error, Idempotency-Key y User-Agent. Se puede filtrar por estado, método, ruta, negocio, periodo y «Solo negocio de prueba»; la vista de detalle muestra una solicitud completa.

En el negocio de prueba se guardan además los cuerpos de la solicitud y de la respuesta (hasta 16.000 caracteres). En los negocios reales, nunca: contienen nombres, números de teléfono y direcciones de clientes. Las cabeceras no se guardan, así que tampoco se guarda ningún token.

Si tu programa detecta un error, busca en el registro el X-Request-Id de la respuesta: ahí verás lo que llegó.

Explorador de API#

El explorador de API ejecuta cualquier operación de la especificación contra tu negocio de prueba. Obtiene el token por sí mismo, válido durante 15 minutos. Eliges la operación, rellenas los parámetros y el cuerpo y ves la respuesta con sus cabeceras, además de la misma llamada en curl, Node.js, Python y PHP, lista para copiar.

Lo que haces ahí es real: un pedido de prueba aceptado queda aceptado, y los eventos van a tu webhook.

Entregas de los webhooks#

En Webhooks aparecen todas las entregas, que puedes filtrar por estado, tipo, negocio y periodo. La vista de detalle muestra el sobre, las cabeceras enviadas con la firma y cada intento: momento, automático o manual, estado HTTP, duración, error y el principio de la respuesta de tu servidor (hasta 2.000 caracteres).

«Reenviar» vuelve a enviar una entrega, con el mismo sobre y el mismo identificador de evento; no cuenta para los intentos automáticos. «Enviar un evento de prueba» envía cualquier tipo con datos de tu negocio de prueba. Más en Webhooks.

Token de prueba#

«Crear token de prueba», en Credenciales, emite un token de acceso y un token de actualización para tu negocio de prueba, sin pasar por el navegador. El token de acceso es válido durante una hora y lleva los permisos de tu app; puedes restringirlo a menos permisos. El token de actualización es válido durante 180 días desde su último uso y se sustituye en cada uso; la renovación se hace en el endpoint de token, con la autenticación de cliente de tu app. La consola muestra los dos tokens una sola vez. Para un negocio real no hay token de prueba: allí decide el propietario.

Especificación OpenAPI#

Toda la API como OpenAPI 3.1, sin autenticación: https://api.flavoso.com/v1/openapi.json. Cada operación tiene un operationId, descripciones, esquemas con ejemplos y respuestas de error; los webhooks están en webhooks. Esta documentación genera su referencia a partir de ella.

Genera los clientes y los tipos directamente a partir de la especificación:

# The specification, without authentication
curl https://api.flavoso.com/v1/openapi.json -o flavoso-openapi.json

# Only the TypeScript types, no runtime (openapi-typescript)
npx openapi-typescript https://api.flavoso.com/v1/openapi.json -o flavoso-api.d.ts

# A complete client, e.g. Python (openapi-generator, needs Java)
npx @openapitools/openapi-generator-cli generate \
  -i https://api.flavoso.com/v1/openapi.json \
  -g python -o ./flavoso-client

Postman#

https://api.flavoso.com/v1/postman.json es una colección de Postman (v2.1) con todas las solicitudes, generada a partir de la especificación. Tiene dos variables: baseUrl y accessToken.

# The Postman collection (v2.1), built from the specification
curl https://api.flavoso.com/v1/postman.json -o flavoso.postman_collection.json

# In Postman: Import › Link › https://api.flavoso.com/v1/postman.json
# Then set the collection variable accessToken to a test token (flv_at_...).
# baseUrl is preset to https://api.flavoso.com/v1

Para modelos de lenguaje#

https://flavoso.com/llms.txt enumera la documentación, la especificación y la colección de Postman en un formato que pueden leer los modelos de lenguaje. Si un asistente te escribe código, lo mejor es darle la especificación.