Choisir qui déclenche l’échange
L’API, ou interface de programmation, d’UBC Data Bridge relie les systèmes externes à des flux contrôlés. Déterminez d’abord quel côté déclenche la requête et quel résultat il attend. Cela permet de choisir la bonne direction de la connexion « REST API » et d’éviter du code intermédiaire inutile.
- Appeler une API externe : Data Bridge lit des enregistrements dans un autre service ou lui envoie des lignes.
- Recevoir des données dans Data Bridge : un partenaire soumet une table ou un fichier ; une livraison acceptée démarre un flux Production.
- Publier les données d’un flux : un consommateur lit un jeu de données préparé ou demande le résultat d’une nouvelle exécution.
Préparer l’environnement et les responsables
L’administrateur vérifie l’adresse HTTPS de l’installation, le routage API par le proxy et « Paramètres → API → Limites API → API Data Bridge activée ». Désignez un responsable d’intégration, un auteur de flux et l’utilisateur qui possédera la clé API. Les destinations nécessitent des droits réels sur les objets cibles : l’accès API seul ne donne pas accès à une table, un cube ou un serveur de messagerie.
Commencez dans un environnement de test avec un petit jeu de données sans données personnelles. Convenez du schéma des champs, des clés d’enregistrement, des formats acceptés, du délai de réponse attendu et du comportement des nouvelles tentatives. Désignez la personne chargée de rapprocher un résultat partiel.
Configurer la connexion et le flux
- Dans « Connexions », créez « REST API », choisissez la direction et donnez un nom distinguant test et production.
- Renseignez les champs propres à la direction. Un service externe nécessite une adresse, une méthode et une authentification ; votre propre point de terminaison nécessite une version API, un identifiant et des règles de réponse.
- Ajoutez le bloc correspondant dans le concepteur : connexion source/destination, « Données entrantes API » ou « Publication de données API ».
- Configurez les transformations, contrôles et destinations. Prévisualisez les tables et exécutez une simulation.
- Enregistrez et publiez Production. Les requêtes clientes utilisent le flux publié ; enregistrer un brouillon ne le remplace pas.
Adresses et versions
La version API fait partie de l’adresse du point de terminaison, par exemple v1 ou v1.1. Elle est distincte de la version 2.1.1 du produit UBC Data Bridge. Copiez l’adresse complète depuis le formulaire : une installation peut inclure un préfixe /databridge , un code d’environnement et un chemin distinct pour le Concepteur. Les points de terminaison et clés d’environnements différents ne sont pas interchangeables.
Les principales routes comprennent POST /api/v1/inbound/orders pour la réception ; GET /api/v1/data/stock pour un jeu de données ; GET /api/v1/ping pour vérifier la clé et l’horloge ; et GET /api/v1/flows pour les flux disponibles. Les identifiants orders et stock sont des exemples à créer dans votre installation.
Distinguer la portée de la clé des droits de l’utilisateur
Pour un point d’entrée protégé, créez un client API avec le droit « Écriture » sur le flux voulu ; la lecture nécessite « Lecture ». Une clé agit au nom de son propriétaire et n’élargit jamais ses droits. Transmettez-la dans Authorization: Bearer ou X-API-Key, jamais dans une URL. Lorsque HMAC, un code d’authentification calculé avec une clé secrète, est activé, chaque requête exige aussi son propre horodatage et sa signature.
L’accès public concerne uniquement un point de publication activé délibérément. Il n’expose ni la réception, ni l’historique, ni la documentation technique. Les règles des clés et un exemple de signature figurent dans le guide des clients API.
Vérifier le cycle complet
Une requête HTTP réussie ne prouve pas que l’opération métier est terminée. Un point d’entrée peut renvoyer 202: conservez l’identifiant de livraison et suivez Location. Pour une publication à la demande, utilisez next pour attendre la même exécution. Comparez l’état, les nombres de lignes et un enregistrement précis dans le système cible.
Testez séparément un champ invalide, une autorisation manquante, une clé d’idempotence répétée et une limite dépassée. Dans « Paramètres → API → Audit des requêtes », retrouvez la requête par flux ou connexion. Rapprochez-la du journal d’exécution et déterminez un périmètre sûr de répétition après toute écriture partielle ou non confirmée.
Poursuivre avec le guide approprié
Recevoir des données et des fichiers présente les schémas, les livraisons et les rappels. Appeler des API externes explique la lecture, la pagination et l’écriture. Publier des données présente les modes de fraîcheur et les paramètres. Le guide de référence technique des points de terminaison explique comment transmettre les détails de configuration à un intégrateur.