Le jeton d'API pour l'Agent BrynQ

Le jeton d'API pour l'Agent BrynQ

Qu'est-ce que le jeton de l'Agent ?

L'Agent BrynQ a besoin d'une clé pour fonctionner : un jeton d'API BrynQ qui appartient à votre environnement BrynQ. Vous le collez une seule fois lors de l'installation de l'Agent. L'Agent le conserve sur le serveur et s'en sert pour prouver à BrynQ à quel client il appartient.

Sans jeton valide, l'Agent ne peut pas établir sa connexion sécurisée avec BrynQ ni se mettre à jour.

À quoi sert le jeton

QuandCe que fait le jeton
Pendant l'installationBrynQ vérifie le jeton et identifie le client auquel il appartient. BrynQ crée ensuite la connexion sécurisée et l'adresse propre à votre Agent : https://<votre-client>.brynq-agent.com.
Mises à jour automatiquesL'Agent utilise le jeton pour rechercher les nouvelles versions et les télécharger depuis BrynQ.
Test de connexionLa page Connexion BrynQ du tableau de bord d'administration local utilise le jeton pour vérifier que BrynQ accepte cet Agent.
Requêtes entrantesL'Agent n'accepte que les requêtes pour votre client. Les requêtes pour un autre client sont refusées, même avec un jeton valide.
ℹ️ Bon à savoir : le jeton n'est pas le mot de passe de votre système local (SQL Server, Active Directory, Sage). Ces paramètres se saisissent séparément dans le programme d'installation ou sur le tableau de bord d'administration.

Quel jeton utiliser

L'Agent n'accepte qu'un jeton lié à un seul client : le client pour lequel l'Agent est installé.

  • ✅ Un jeton créé dans votre propre environnement BrynQ.
  • ❌ Un jeton personnel ou administrateur ayant accès à plusieurs clients, ou à aucun. BrynQ le refuse et le programme d'installation indique que ce n'est pas un jeton d'agent.
  • ❌ Des identifiants API avec un Client ID et un Client Secret. L'Agent a besoin d'un jeton unique, pas d'un Client ID et d'un secret.

Comment obtenir le jeton

Demandez le jeton d'Agent de votre environnement à votre consultant BrynQ ou au support BrynQ. BrynQ le crée pour vous et vous le transmet de façon sécurisée.

À convenir avant la création du jeton :

  • Période de validité. Un jeton peut être valable 30, 90, 180 ou 365 jours, ou sans date d'expiration. Quand le jeton expire, l'Agent ne peut plus se mettre à jour ni rétablir sa connexion. Convenez de qui remplace le jeton à temps.
  • Liste blanche d'adresses IP (facultatif). Le jeton peut être limité à certaines adresses IP. Si vous le souhaitez, communiquez à BrynQ l'adresse IP publique avec laquelle votre serveur sort sur Internet. Le programme d'installation et le tableau de bord d'administration affichent cette adresse. Laissez la liste vide si votre serveur n'a pas d'adresse publique fixe.
⚠️ Gardez le jeton secret. BrynQ n'affiche un jeton qu'une seule fois, à sa création. Traitez-le comme un mot de passe : ne le partagez pas dans des discussions ou des e-mails avec des personnes qui n'en ont pas besoin, et ne l'enregistrez pas dans un document partagé.

Pour les consultants BrynQ

  1. Ouvrez l'environnement du client dans BrynQ.
  2. Dans la barre latérale, sous Développeur, cliquez sur Identifiants API.
  3. Ouvrez l'onglet Jetons hérités (marqué v2).
    L'onglet Jetons hérités (v2) de la page Identifiants API
  4. Cliquez sur Créer un jeton hérité. Saisissez un Libellé clair, par exemple BrynQ Agent – <nom du serveur>, choisissez la Période de validité et, si convenu, ajoutez l'adresse IP publique du serveur sous Adresses IP autorisées (appuyez sur Entrée après chaque adresse). Cliquez ensuite sur Créer un jeton hérité dans la fenêtre.
    La fenêtre Créer un jeton hérité
  5. Copiez le jeton immédiatement et cliquez sur J'ai enregistré mon jeton.
Feuille de route : l'Agent utilise pour l'instant un jeton hérité (v2). À l'avenir, il utilisera à la place des identifiants API (v1). Cet article sera mis à jour lors de ce changement.

N'utilisez pas de jeton de la page Admin Portal › Accès API : ce sont des jetons administrateur pour tous les clients, et l'Agent les refuse.

Saisir le jeton pendant l'installation

  1. Lancez le programme d'installation de l'Agent BrynQ (voir Installer l'Agent BrynQ pour l'installation complète).
  2. Sur la page Connexion cloud, collez le jeton dans le champ Jeton d'API. Le champ est masqué.
  3. Le programme d'installation vérifie le jeton auprès de BrynQ pendant la saisie. Suivant n'est disponible qu'une fois le jeton accepté. Le client est déterminé automatiquement à partir du jeton.
  4. Terminez l'installation. L'Agent enregistre le jeton sur le serveur, protégé par le chiffrement Windows (DPAPI). Il n'est jamais écrit dans les journaux ni affiché à nouveau.

Lors d'une réinstallation ou d'une mise à niveau, le programme d'installation détecte qu'un jeton est déjà enregistré. Laissez Garder le jeton d'API existant (recommandé) sélectionné, ou choisissez Le remplacer par un nouveau jeton d'API et collez le nouveau.

Remplacer un jeton expiré ou révoqué

Il n'est pas nécessaire de réinstaller l'Agent pour remplacer le jeton.

  1. Demandez un nouveau jeton d'Agent à BrynQ.
  2. Ouvrez le tableau de bord d'administration local sur le serveur de l'Agent.
  3. Allez sur la page Connexion BrynQ.
  4. Sous Remplacer le jeton d'API, collez le jeton dans Nouveau jeton d'API et cliquez sur Vérifier et enregistrer.

BrynQ vérifie d'abord le nouveau jeton. Il n'est enregistré que si BrynQ l'accepte pour votre client : un mauvais jeton ne remplace donc jamais un jeton qui fonctionne.

Dépannage

Le programme d'installation et la page Connexion BrynQ indiquent pourquoi BrynQ n'accepte pas un jeton. Pour les autres problèmes, voir Dépannage de l'Agent BrynQ.

MessageSignificationQue faire
BrynQ ne connaît pas ce jeton d'API (TOKEN_NOT_FOUND)Le jeton n'existe pas, a été révoqué ou n'a pas été copié en entier.Copiez à nouveau le jeton en entier. Toujours refusé ? Demandez un nouveau jeton à BrynQ.
Le jeton d'API a expiré (TOKEN_EXPIRED)La période de validité du jeton est dépassée.Demandez un nouveau jeton à BrynQ et remplacez-le sur la page Connexion BrynQ.
L'utilisateur BrynQ auquel appartient ce jeton d'API n'existe plus (RELATED_USER_NOT_FOUND)Le jeton a été créé par un utilisateur BrynQ qui a depuis été supprimé.Demandez un nouveau jeton à BrynQ.
BrynQ n'accepte ce jeton d'API que depuis d'autres adresses IP (IP_NOT_ALLOWED)Le jeton a une liste blanche d'adresses IP qui ne contient pas l'adresse IP publique de votre serveur.Demandez à BrynQ d'ajouter l'adresse affichée sous Adresse IP publique à la liste blanche du jeton, ou de supprimer la liste. Cliquez ensuite sur Vérifier à nouveau.
BrynQ connaît le jeton, mais ce n'est pas un jeton d'agent (AGENT_TOKEN_MUST_TARGET_EXACTLY_ONE_CUSTOMER)Le jeton est lié à plusieurs clients ou à aucun, par exemple un jeton administrateur.Utilisez un jeton créé dans votre propre environnement BrynQ (voir Quel jeton utiliser).
BrynQ lie le jeton à un autre clientLe jeton appartient à un autre environnement BrynQ que cet Agent.Utilisez le jeton d'Agent de votre propre environnement.
La plateforme BrynQ ne répond pasBrynQ est temporairement occupé ou indisponible.Attendez quelques minutes et cliquez sur Vérifier à nouveau.
BrynQ est injoignableLe serveur ne peut pas établir de connexion HTTPS sortante vers BrynQ.Demandez à votre administrateur informatique d'autoriser le trafic HTTPS sortant vers BrynQ (voir ci-dessous), y compris via un éventuel proxy.

L'adresse de BrynQ pour votre pare-feu

La vérification du jeton, le test de connexion et les mises à jour partent tous en sortie de votre serveur vers BrynQ. Aucun port entrant n'est nécessaire. Si votre pare-feu ou votre proxy n'autorise le trafic sortant que vers des destinations approuvées, autorisez :

DestinationAdresse IPPort
app.brynq.com20.54.225.251TCP 443 (HTTPS)

Autorisez le nom d'hôte app.brynq.com si votre pare-feu le permet, et l'adresse IP s'il n'accepte que des adresses IP. La vérification Connexions sortantes sur la page Dépannage du tableau de bord d'administration indique si le serveur peut joindre BrynQ. Le Cloudflare Tunnel a besoin de son propre port sortant : voir Paramètres réseau de l'Agent BrynQ.

Ne confondez pas les deux adresses : 20.54.225.251 est l'adresse de BrynQ, que votre pare-feu autorise. L'Adresse IP publique de votre serveur est celle que BrynQ ajoute à la liste blanche du jeton.

Articles associés