Strumenti

La console#

La console si trova su app.flavoso.com/it/developers. Basta un account Flavoso, senza locale e senza abbonamento. Per ogni app ci sono queste sezioni:

Accanto ci sono il locale di prova con i suoi strumenti, comune a tutte le tue app, e la configurazione finché non è conclusa.

Registro delle richieste#

Ogni richiesta della tua app con un token valido resta nel registro per 14 giorni: ora, locale, metodo, percorso, operazione (operationId), parametri di query, stato, durata, X-Request-Id, codice di errore, Idempotency-Key e User-Agent. Puoi filtrarlo per stato, metodo, percorso, locale, periodo e «Solo locale di prova»; la vista di dettaglio mostra una richiesta per intero.

Per il locale di prova ci sono anche i corpi di richiesta e risposta (fino a 16.000 caratteri). Per i locali reali mai, perché contengono nomi, numeri di telefono e indirizzi dei clienti. Le intestazioni non vengono salvate, quindi nemmeno i token.

Se il tuo programma segnala un errore, cerca nel registro la X-Request-Id della risposta: lì vedi cosa è arrivato.

Esploratore API#

L'esploratore API esegue ogni operazione della specifica sul tuo locale di prova. Il token lo ottiene da solo e vale 15 minuti. Scegli l'operazione, compili parametri e corpo e vedi la risposta con le sue intestazioni, più la stessa chiamata in curl, Node.js, Python e PHP da copiare.

Ciò che fai lì è reale: un ordine di prova accettato è accettato, e gli eventi vanno al tuo webhook.

Consegne dei webhook#

Sotto Webhook trovi ogni consegna, filtrabile per stato, tipo, locale e periodo. La vista di dettaglio mostra la busta, le intestazioni inviate con la firma e ogni tentativo: ora, automatico o manuale, stato HTTP, durata, errore e l'inizio della risposta del tuo server (fino a 2.000 caratteri).

«Rinvia» invia di nuovo una consegna, con la stessa busta e lo stesso identificativo dell'evento; non conta tra i tentativi automatici. «Invia un evento di prova» invia eventi di qualsiasi tipo con i dati del tuo locale di prova. Di più in Webhook.

Token di prova#

«Crea token di prova» nelle Credenziali rilascia un token di accesso e un token di aggiornamento per il tuo locale di prova, senza passare dal browser. Il token di accesso vale un'ora e porta i permessi della tua app; puoi limitarlo a meno permessi. Il token di aggiornamento vale 180 giorni dall'ultimo utilizzo e viene sostituito a ogni utilizzo; si rinnova all'endpoint del token, con l'autenticazione della tua app. La console mostra entrambi i token una sola volta. Per un locale reale non esiste un token di prova: lì decide il titolare.

Specifica OpenAPI#

Tutta l'API come OpenAPI 3.1, senza autenticazione: https://api.flavoso.com/v1/openapi.json. Ogni operazione ha un operationId, descrizioni, schemi con esempi e risposte di errore; i webhook sono sotto webhooks. Questa documentazione ne ricava il suo riferimento.

Client e tipi generati conviene ricavarli direttamente dalla specifica:

# 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 è una raccolta Postman (v2.1) con ogni richiesta, costruita dalla specifica. Ha due variabili: baseUrl e 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

Per i modelli linguistici#

https://flavoso.com/llms.txt elenca la documentazione, la specifica e la raccolta Postman in una forma che un modello linguistico sa leggere. Se fai scrivere codice a un assistente, dagli la specifica.