Appeler l'API

Une fois votre API activée, vous pouvez l'appeler en utilisant la syntaxe OData.

Syntaxe générale

Pour appeler votre API, vous avez besoin de :

l'URL de l'API. Elle se compose d'une URL de base et du chemin d'API généré lors de l'activation de l'API. Si vous utilisez un Moteur Cloud pour le design, cette URL s'affiche dans l'onglet d'API de votre jeu de données. Si vous utilisez un Moteur distant Gen2, seul le chemin de l'API est affiché. Contactez votre administrateur·trice pour obtenir l'URL de base.
Pour insérer /apis/ entre l'URL de base et le chemin d'API. Un modèle d'URL pour un appel d'API peut être, par exemple <base_url>/apis/<api_path>.
Identifiants définis lors de la création du consommateur ou de la consommatrice à utiliser.

Lorsque vous appelez une API sur un Moteur Cloud pour le design, vous devez prendre en compte les limitations suivantes :

La fréquence d'appel est limitée à 30 requêtes par secondes et par IP client·e entrante.
Les machines sur le même réseau VPN comptent comme une adresse IP car elles ont la même adresse IP publique.

Avertissement : Un problème temporaire peut causer la conversion en string des colonnes utilisant certains types sémantiques dans le jeu de données source lors de l'appel de l'API :

valeurs boolean
dates, y compris les dates et les heures
integer et valeurs décimales, pour Oracle
valeurs integer longues, bigint en SQL

Test sur un environnement personnel

Prenez l'exemple d'un jeu de données contenant des informations client·es simples, créé via une connexion hébergée sur un Moteur distant Gen2 installé sur votre machine personnelle. Après avoir activé une API pour le jeu d'entités nommé customers et le chemin d'API customers-api-2PZPTB, vous pouvez l'appeler avec l'outil de votre choix, via l'URL suivante :

http://localhost:8080/apis/customers-api-2PZPTB/customers

Comme l'API est hébergée sur votre machine personnelle, l'URL de base de votre API sera simplement http://localhost:8080. Cette requête retourne les informations concernant le jeu de données complet.

Exemple d'appel d'API en production

Lorsque vous appelez la même API dans un contexte de production, certains paramètres sont modifiés, créant l'URL suivante :

https://mycompany.com/apis/customers-api-2PZPTB/customers

L'API doit être sécurisée via HTTPS. Consultez Sécuriser l'API pour plus d'informations concernant la configuration HTTPS.
L'URL de base a été configurée par votre administrateur·trice pour refléter le domaine de votre entreprise ou tout autre format personnalisé.

Le reste de l'URL, la partie /apis/ et le chemin d'accès à l'API, reste indentique.

Pour plus d'exemples d'appels utilisant l'expressivité OData supportée, consultez Expressivité des API.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici