Outils

La console#

La console est disponible sur app.flavoso.com/fr/developers. Il suffit d'un compte Flavoso, sans établissement ni abonnement. Chaque application dispose de ces rubriques :

À côté se trouvent l'établissement de test avec ses outils, partagé par toutes vos applications, et la configuration tant qu'elle n'est pas terminée.

Journal des requêtes#

Chaque requête de votre application qui porte un jeton valide reste 14 jours dans le journal : heure, établissement, méthode, chemin, opération (operationId), paramètres de requête, statut, durée, X-Request-Id, code d'erreur, Idempotency-Key et User-Agent. Vous pouvez le filtrer par statut, méthode, chemin, établissement, période et « Établissement de test uniquement » ; la vue détaillée affiche une requête dans son intégralité.

Pour l'établissement de test, les corps de la requête et de la réponse sont aussi enregistrés (jusqu'à 16 000 caractères). Pour les établissements réels, jamais : ils contiennent les noms, numéros de téléphone et adresses des clients. Les en-têtes ne sont pas enregistrés, donc aucun jeton non plus.

Quand votre programme signale une erreur, cherchez dans le journal l'X-Request-Id de la réponse : vous y verrez ce que Flavoso a reçu.

Explorateur d'API#

L'explorateur d'API exécute n'importe quelle opération de la spécification sur votre établissement de test. Il obtient lui-même son jeton, valable 15 minutes. Vous choisissez l'opération, remplissez les paramètres et le corps, et voyez la réponse avec ses en-têtes, ainsi que le même appel en curl, Node.js, Python et PHP, prêt à copier.

Ce que vous y faites est réel : une commande test acceptée l'est vraiment, et des événements partent vers votre webhook.

Livraisons des webhooks#

Sous Webhooks, vous trouvez chaque livraison, filtrable par statut, type, établissement et période. La vue détaillée montre l'enveloppe, les en-têtes envoyés, signature comprise, et chaque tentative : heure, automatique ou manuelle, statut HTTP, durée, erreur et le début de la réponse de votre serveur (jusqu'à 2 000 caractères).

« Renvoyer » relance une livraison, avec la même enveloppe et le même identifiant d'événement, sans entamer les tentatives automatiques. « Envoyer un événement de test » envoie un événement de n'importe quel type, avec des données de votre établissement de test. Plus de détails sous Webhooks.

Jeton de test#

« Créer un jeton de test », dans les Identifiants, délivre un jeton d'accès et un jeton de rafraîchissement pour votre établissement de test, sans passer par le navigateur. Le jeton d'accès est valable une heure et porte les droits de votre application ; vous pouvez le restreindre à moins de droits. Le jeton de rafraîchissement est valable 180 jours à compter de sa dernière utilisation et il est remplacé à chaque utilisation ; le rafraîchissement se fait auprès du point de terminaison des jetons, avec l'authentification client de votre application. La console affiche les deux jetons une seule fois. Pour un établissement réel, il n'existe pas de jeton de test : c'est le propriétaire qui décide.

Spécification OpenAPI#

Toute l'API en OpenAPI 3.1, sans authentification : https://api.flavoso.com/v1/openapi.json. Chaque opération a un operationId, des descriptions, des schémas avec exemples et des réponses d'erreur ; les webhooks figurent sous webhooks. La référence de cette documentation est générée à partir de cette spécification.

Générez vos clients et vos types directement à partir de la spécification :

# 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 est une collection Postman (v2.1) qui contient toutes les requêtes, générée à partir de la spécification. Elle utilise deux variables : baseUrl et 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

Pour les modèles de langage#

https://flavoso.com/llms.txt répertorie la documentation, la spécification et la collection Postman sous une forme lisible par un modèle de langage. Si un assistant écrit du code pour vous, donnez-lui la spécification.