De API-token voor de BrynQ Agent

De API-token voor de BrynQ Agent

Wat is de Agent-token?

De BrynQ Agent heeft één sleutel nodig om te werken: een BrynQ API-token die bij je BrynQ-omgeving hoort. Je plakt hem één keer tijdens de installatie van de Agent. De Agent bewaart hem op de server en gebruikt hem om aan BrynQ te laten zien bij welke klant hij hoort.

Zonder geldige token kan de Agent geen beveiligde verbinding met BrynQ opzetten en zichzelf niet bijwerken.

Waarvoor de token wordt gebruikt

WanneerWat de token doet
Tijdens de installatieBrynQ controleert de token en zoekt op bij welke klant hij hoort. Daarna maakt BrynQ de beveiligde verbinding en het eigen adres van je Agent aan: https://<jouw-klant>.brynq-agent.com.
Automatische updatesDe Agent gebruikt de token om nieuwe versies te zoeken en bij BrynQ te downloaden.
VerbindingstestDe pagina BrynQ-verbinding van het lokale beheerdashboard gebruikt de token om te testen of BrynQ deze Agent accepteert.
Inkomende verzoekenDe Agent accepteert alleen verzoeken voor jouw klant. Verzoeken voor een andere klant worden geweigerd, ook met een geldige token.
ℹ️ Goed om te weten: de token is niet het wachtwoord van je lokale systeem (SQL Server, Active Directory, Sage). Die instellingen vul je apart in, in de installer of op het beheerdashboard.

Welke token je nodig hebt

De Agent accepteert alleen een token die aan precies één klant is gekoppeld: de klant waarvoor de Agent wordt geïnstalleerd.

  • ✅ Een token die is aangemaakt in je eigen BrynQ-omgeving.
  • ❌ Een persoonlijke token of beheerderstoken met toegang tot meerdere klanten, of tot geen enkele. BrynQ weigert die en de installer meldt dat het geen agent-token is.
  • ❌ API-referenties met een Client ID en Client Secret. De Agent heeft één token nodig, geen Client ID en secret.

Zo krijg je de token

Vraag je BrynQ-consultant of BrynQ support om de Agent-token van je omgeving. BrynQ maakt hem voor je aan en stuurt hem veilig op.

Spreek dit af voordat de token wordt aangemaakt:

  • Geldigheidsperiode. Een token kan 30, 90, 180 of 365 dagen geldig zijn, of geen einddatum hebben. Als de token verloopt, kan de Agent zichzelf niet meer bijwerken en zijn verbinding niet opnieuw opzetten. Spreek af wie de token op tijd vervangt.
  • IP-whitelist (optioneel). De token kan worden beperkt tot bepaalde IP-adressen. Wil je dat, geef BrynQ dan het openbare IP-adres waarmee je server het internet op gaat. De installer en het beheerdashboard tonen dit adres. Laat de whitelist leeg als je server geen vast openbaar adres heeft.
⚠️ Houd de token geheim. BrynQ toont een token maar één keer, bij het aanmaken. Behandel hem als een wachtwoord: deel hem niet in chats of e-mails met mensen die hem niet nodig hebben, en bewaar hem niet in een gedeeld document.

Voor BrynQ-consultants

  1. Open de omgeving van de klant in BrynQ.
  2. Klik in de zijbalk, onder Ontwikkelaar, op API-referenties.
  3. Open het tabblad Verouderde tokens (gemarkeerd met v2).
    Het tabblad Verouderde tokens (v2) op de pagina API-referenties
  4. Klik op Verouderd token aanmaken. Vul een duidelijk Label in, bijvoorbeeld BrynQ Agent – <servernaam>, kies de Geldigheidsperiode en voeg, als dat is afgesproken, het openbare IP-adres van de server toe onder Toegestane IP-adressen (druk na elk adres op Enter). Klik daarna in het venster op Verouderd token aanmaken.
    Het venster Verouderd token aanmaken
  5. Kopieer de token meteen en klik op Ik heb mijn token opgeslagen.
Roadmap: de Agent gebruikt voorlopig een verouderd token (v2). In de toekomst gebruikt hij in plaats daarvan API-referenties (v1). Dit artikel wordt bijgewerkt zodra dat verandert.

Gebruik geen token van de pagina Admin Portal › API toegang: dat zijn beheerderstokens voor alle klanten, en die weigert de Agent.

De token invullen tijdens de installatie

  1. Start de installer van de BrynQ Agent (zie De BrynQ Agent installeren voor de volledige installatie).
  2. Plak de token op de pagina Cloudverbinding in het veld API-token. Het veld is gemaskeerd.
  3. De installer controleert de token bij BrynQ terwijl je typt. Volgende werkt pas als BrynQ hem accepteert. De klant wordt automatisch ingevuld op basis van de token.
  4. Rond de installatie af. De Agent bewaart de token op de server, beveiligd met Windows-versleuteling (DPAPI). Hij komt nooit in logbestanden en wordt niet meer getoond.

Installeer je opnieuw of voer je een upgrade uit, dan ziet de installer dat er al een token is opgeslagen. Laat Het bestaande API-token behouden (aanbevolen) geselecteerd, of kies Vervangen door een nieuw API-token en plak de nieuwe.

Een verlopen of ingetrokken token vervangen

Je hoeft de Agent niet opnieuw te installeren om de token te vervangen.

  1. Vraag BrynQ om een nieuwe Agent-token.
  2. Open het lokale beheerdashboard op de Agent-server.
  3. Ga naar de pagina BrynQ-verbinding.
  4. Plak onder API-token vervangen de token in Nieuwe API-token en klik op Controleren en opslaan.

BrynQ controleert de nieuwe token eerst. Hij wordt alleen opgeslagen als BrynQ hem voor jouw klant accepteert, dus een verkeerde token vervangt nooit een werkende.

Problemen oplossen

De installer en de pagina BrynQ-verbinding vertellen je waarom BrynQ een token niet accepteert. Voor andere problemen, zie Problemen met de BrynQ Agent oplossen.

MeldingWat het betekentWat te doen
BrynQ kent deze API-token niet (TOKEN_NOT_FOUND)De token bestaat niet, is ingetrokken of is niet helemaal gekopieerd.Kopieer de hele token opnieuw. Nog steeds geweigerd? Vraag BrynQ om een nieuwe token.
De API-token is verlopen (TOKEN_EXPIRED)De geldigheidsperiode van de token is voorbij.Vraag BrynQ om een nieuwe token en vervang hem op de pagina BrynQ-verbinding.
De BrynQ-gebruiker van deze API-token bestaat niet meer (RELATED_USER_NOT_FOUND)De token is aangemaakt door een BrynQ-gebruiker die inmiddels is verwijderd.Vraag BrynQ om een nieuwe token.
BrynQ accepteert deze API-token alleen vanaf andere IP-adressen (IP_NOT_ALLOWED)De token heeft een IP-whitelist waar het openbare IP-adres van je server niet in staat.Vraag BrynQ het adres onder Openbaar IP-adres aan de whitelist van de token toe te voegen, of de whitelist te verwijderen. Klik daarna op Opnieuw controleren.
BrynQ kent de token, maar het is geen agent-token (AGENT_TOKEN_MUST_TARGET_EXACTLY_ONE_CUSTOMER)De token is gekoppeld aan meerdere klanten of aan geen enkele, bijvoorbeeld een beheerderstoken.Gebruik een token die in je eigen BrynQ-omgeving is aangemaakt (zie Welke token je nodig hebt).
BrynQ koppelt de token aan een andere klantDe token hoort bij een andere BrynQ-omgeving dan deze Agent.Gebruik de Agent-token van je eigen omgeving.
Het BrynQ-platform reageert nietBrynQ is tijdelijk druk of niet beschikbaar.Wacht een paar minuten en klik op Opnieuw controleren.
BrynQ is niet bereikbaarDe server kan geen uitgaande HTTPS-verbinding met BrynQ maken.Vraag je IT-beheerder uitgaand HTTPS-verkeer naar BrynQ toe te staan (zie hieronder), ook via een eventuele proxy.

Het adres van BrynQ voor je firewall

De tokencontrole, de verbindingstest en de updates gaan allemaal uitgaand van je server naar BrynQ. Er is geen inkomende poort nodig. Laat je firewall of proxy alleen uitgaand verkeer naar goedgekeurde bestemmingen toe, sta dan toe:

BestemmingIP-adresPoort
app.brynq.com20.54.225.251TCP 443 (HTTPS)

Sta de hostnaam app.brynq.com toe als je firewall dat ondersteunt, en het IP-adres als hij alleen IP-adressen accepteert. De controle Uitgaande verbindingen op de pagina Probleemoplossing van het beheerdashboard laat zien of de server BrynQ kan bereiken. De Cloudflare Tunnel heeft een eigen uitgaande poort nodig: zie Netwerkinstellingen van de BrynQ Agent.

Haal de twee adressen niet door elkaar: 20.54.225.251 is het adres van BrynQ, dat jouw firewall toestaat. Het Openbaar IP-adres van je server is wat BrynQ aan de IP-whitelist van de token toevoegt.

Gerelateerde artikelen