Comment utiliser l'API Yodacloud Consult ?

Informations générales

• URL de l'API : https://consult.api.yodaforex.cloud/
• URL du swagger : https://consult.api.yodaforex.cloud/swagger-ui
• Clé API : celle fourni lors de votre souscription à l'abonnement, elle assure la sécurité de vos données

Consommation quotidienne de l'API

Votre abonnement Yodacloud permet de consommer 100 secondes d'API Yodacloud Connect par jour, une requête à la fois.
Au delà de cette limite une offre commerciale doit être établie pour votre usage.

/v1/access-control-status retourne le temps quotidien utilisé en millisecondes et le temps restant.

Pour maitriser au mieux votre consommation, vous pouvez ajouter le header X-Timeout à votre requête HTTP. Si le temps d'exécution de votre requête dépasse la durée spécifiée par ce header (exprimée en milliseconde), un code HTTP 408 vous est immédiatement retourné, et le temps d'exécution ne vous sera pas décompté.

Les types de données requêtables

Les entités requêtables sont :

• products
• invoices
• invoice-lines
• customers

Rechercher une liste /v1/{entity}

Une entité peut être utilisée soit pour récupérer des données, soit pour exécuter un calcul.

Par défaut une liste se positionne sur la page 1 et affiche les premiers 100 résultats.

Recherche de base

• /v1/products
• /v1/invoices
• /v1/invoice-lines
• /v1/customers

Pagination

/v1/products?page=2&pageSize=50

Filtrage et requête spécifique

Pour écrire des requêtes de filtrage, il est nécessaire de séparer chaque composant de la requête par un espace, et d'encadrer les chaines de caractères par des double guillemets.

Il est possible de créer des conditions complexes avec des parenthèses et avec les opérateurs binaires AND et OR.

Tous les champs sont requêtables

Récupérer les produits créés par SAMI

/v1/products?page=1&query=createdBy = "SAMI"

Récupérer les produits favoris

/v1/products?page=1&query=isFavorite = true

Récupérer les produits favoris créés par TOTO

/v1/products?page=1&pageSize=20&query=isFavorite = true AND createdBy = "TOTO"

Récupérer les factures du 01/01/2020

/v1/invoices?query=date = "2020-01-01"

Récupérer les factures de janvier 2020

/v1/invoices?query=date >= "2020-01-01" AND date < "2020-02-01"

Récupérer les lignes de factures d'une facture dont on connait l'identifiant

/v1/invoices-lines/query=invoiceId = "SOME_INVOICE_ID"

Calculer la somme des valeurs fiscales de tous les produits de la famille "or de bourse"

/v1/products?compute=sum&toCompute=fiscalValue&query=familyCode = "OB"

Calculer le nombre de clients nommés Dupont

/v1/customers/query=lastName = "Dupont"&compute=count

Récupérer les produits et trier par famille, puis pour chaque famille trier par valeur fiscale décroissante

/v1/products?sort=familyCode&sort=fiscalValue,desc

Rechercher un objet /v1/{entity}/{entityId}

Permet d'accéder directement à la fiche voulue en utilisant son identifiant

/v1/products/B95ED4AFB0D346D1A124E12B73FFA289