Module REST

Module REST

Ce qu'il fait

Le module REST permet à BrynQ d'appeler une API REST au sein de votre réseau. BrynQ envoie la requête (ou un lot de requêtes) à l'Agent ; l'Agent appelle l'API interne et renvoie la réponse, y compris le code de statut et les en-têtes.

  • Il prend en charge l'authentification NTLM / Negotiate, souvent exigée par les applications IIS sur site (par exemple Exact Synergy, SharePoint ou d'anciennes versions de Dynamics).
  • Les réponses binaires, comme les fichiers PDF, sont renvoyées de manière sûre (encodées en base64).
  • Chaque redirection est vérifiée comme la première adresse. L'Agent n'appelle jamais sa propre page d'administration.

Quand l'utiliser

  • Une application sur site possède une API REST qui n'est pas accessible depuis Internet.
  • L'API exige une authentification Windows (NTLM).

Pas pour : les API cloud que BrynQ peut joindre directement.

Le configurer

Pendant l'installation : sur la page Modules, cochez Proxy REST. L'adresse de l'API et les identifiants sont définis dans l'interface dans BrynQ.

Ensuite : le tableau de bord d'administration local (http://127.0.0.1:7071/admin, sur le serveur lui-même) > REST contient ces paramètres :

ChampSignification
Délai d'expiration par défaut (secondes)Combien de temps l'Agent attend l'API interne. Par défaut : 30.
Modèles d'URL autorisésLes adresses internes que BrynQ peut appeler, une par ligne, par exemple http://localhost:* ou https://hr-api.example.local/api/*. Vide : toute URL. Un * dans le nom du serveur remplace une seule partie entre deux points (un * seul : tout serveur) ; sans port, seulement le port par défaut (80, 443) ; sans chemin, tout chemin.

Cliquez sur Enregistrer.

Dépannage

Ce que vous voyezQue faire
Statut 403 avec "Refused: <address> (not in the allowed URL patterns on the agent)" (refusé : l'adresse ne figure pas dans les modèles d'URL autorisés sur l'agent)L'adresse ne figure pas dans Modèles d'URL autorisés. Ajoutez-la sur la page REST et cliquez sur Enregistrer. Une redirection vers une adresse hors des modèles est refusée de la même façon.
Statut 502 avec le code d'erreur OUTBOUND_REQUEST_FAILEDL'Agent n'a reçu aucune réponse de l'API interne : adresse erronée, problème DNS, connexion refusée ou délai dépassé. Ouvrez l'adresse de l'API dans un navigateur sur le serveur de l'Agent pour la tester. Pour une API lente, augmentez Délai d'expiration par défaut (secondes).
Un autre statut d'erreur (401, 404, 500...)C'est l'API interne elle-même qui a répondu avec ce statut. Vérifiez l'adresse et les identifiants dans l'interface, ainsi que les journaux de cette application.
401 avec l'authentification NTLM/WindowsVérifiez le nom d'utilisateur (DOMAINE\utilisateur) et le mot de passe utilisés par l'interface.
Un module 404 Not FoundLe module REST n'est pas activé. Relancez le programme d'installation et cochez Proxy REST sur la page Modules.
⚠ Attention aux nouvelles tentatives. Avec OUTBOUND_REQUEST_FAILED, la requête a pu malgré tout atteindre l'application interne. Renvoyer une requête qui crée ou modifie des données peut alors créer un doublon.

Plus d'informations : Dépannage de l'Agent BrynQ.