API

ArchibotChat API-sleutels

Maak, kopieer, roteer en trek gegenereerde API-sleutels in en koppel een externe collega-tool aan het openbare Archibot-endpoint.

KlantbeheerdersKlantledenPlatformbeheerders

Laatst bijgewerkt 18 juni 2026

Het tabblad API-sleutels in Instellingen: gegenereerde sleutels worden hier gemaakt, de ruwe waarde wordt eenmaal getoond en een kopieerbaar installatiescript koppelt een externe collega-tool aan het endpoint.

Met API-sleutels kun je het openbare Archibot-endpoint aanroepen vanuit scripts, lokale agent-tools en integraties die buiten een beheerde workspace draaien. Ze staan los van de verborgen referentie die het Chat-scherm in de browser aandrijft, die nooit aan gebruikers wordt getoond.

Beheerde Archibot-workspaces voorzien hun eigen sleutels al automatisch van inrichting. Gebruik een gegenereerde API-sleutel alleen voor een lokale agent-tool, een editor-extensie of een door de klant beheerd harnas dat Archibot als externe collega moet aanroepen.

Wanneer API-sleutels gebruiken

Maak een gegenereerde sleutel wanneer je het volgende moet doen:

Archibot aanroepen vanuit een script of een geplande taak.
Een lokale agent-tool of editor-extensie verbinden met het endpoint.
Een OpenAI-compatibele client uitvoeren tegen het Archibot-endpoint.
Een door de klant beheerd harnas buiten de workspace koppelen aan Archibot.

Gebruik voor interactieve vragen in plaats daarvan het Chat-scherm in de browser. Zie ArchibotChat gebruiken.

Het tabblad API-sleutels openen

Open Instellingen vanuit de linkernavigatie.
Selecteer de weergave Archibot account.
Open het tabblad API Keys.

Het tabblad bevindt zich op dezelfde rij als Setup, Git access, CI & Review, Support, Activity en Billing. Als API-toegang niet is ingeschakeld voor het account, toont het tabblad het bericht API access is not enabled for this account. en is de knop Create key uitgeschakeld. Vraag eerst een klantbeheerder of ISM om de API-productpoort in te schakelen. Zie ArchibotChat-installatie.

Tabblad API-sleutels in Console-instellingen met de knop Sleutel maken, de kaart voor externe collega-toegang en een gegenereerd installatiescript met tijdelijke aanduidingen voor endpoint en sleutel.

Een sleutel maken

Kies op het tabblad API Keys de optie Create key.
De nieuwe sleutel verschijnt bovenaan de lijst en de volledige waarde wordt eenmaal getoond in een gemarkeerde melding die luidt Copy this key now. It will not be shown again.
Kies Copy naast de sleutelwaarde.
Sla deze op in je goedgekeurde secret manager of runtime-omgeving.

Tabblad API-sleutels direct na het maken van een sleutel, met de eenmalige sleutelmelding die aangeeft dat de sleutel niet opnieuw wordt getoond, met een knop Kopiëren.

Sleutels worden automatisch benoemd (bijvoorbeeld Console generated key 1) en krijgen het bereik api. De ruwe waarde wordt alleen in deze melding getoond. Zodra je het tabblad verlaat of een andere sleutel maakt, blijven alleen het sleutelprefix en de metadata zichtbaar.

Als de kopieerknop je klembord niet kan bereiken, toont het tabblad Clipboard copy unavailable. Selecteer de sleuteltekst handmatig en kopieer deze voordat je wegnavigeert.

Een externe collega-tool koppelen

De kaart External coworker access bouwt een kant-en-klaar installatiescript zodat je de omgevingsvariabelen niet met de hand hoeft samen te stellen.

De kaart toont twee referentievelden:

Veld	Wat het toont
Public endpoint	De basis-URL die je integratie moet aanroepen, bijvoorbeeld `https://chat.archibot.cloud/v1`.
Key source	`New one-time key included` direct nadat je een sleutel hebt gemaakt of geroteerd, anders `Generate or rotate a key`.

Onder die velden toont een voorbeeld een shellscript dat de omgevingsvariabelen voor het endpoint en de sleutel exporteert en een voorbeeld-collega-opdracht uitvoert. Wanneer je net een sleutel hebt gemaakt of geroteerd, bevat het script die eenmalige sleutelwaarde; anders gebruikt het een tijdelijke aanduiding <new-api-key>.

Maak of roteer een sleutel zodat het veld Key source New one-time key included toont.
Kies Copy setup op de kaart External coworker access.
Plak het script in je lokale shell, secret manager of toolconfiguratie.

Het script stelt standaard OpenAI-compatibele variabelen in (OPENAI_BASE_URL, OPENAI_API_KEY) naast Archibot-collega-variabelen, zodat zowel OpenAI-compatibele clients als de Archibot-collega-tooling hetzelfde endpoint en dezelfde sleutel oppakken. Gebruik de productie-endpoint-URL die ISM voor je account heeft verstrekt in plaats van deze af te leiden uit een lokaal voorbeeld.

Een sleutel gebruiken

Gebruik de sleutel als bearer-token tegen het OpenAI-compatibele Archibot-endpoint.

curl https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Summarize this Archibus request queue export."
  }'

Het endpoint stuurt OpenAI-compatibele velden van de Responses API zoals tools, tool_choice, reasoning, metadata en gestructureerde input-inhoud door naar het Archibot-endpoint nadat de API-sleutel- en kredietcontroles zijn geslaagd.

Stuur voor gestreamde antwoorden stream: true:

curl -N https://chat.example.archibot.cloud/v1/responses \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "archibot",
    "input": "Draft a short work plan for this Archibus data cleanup.",
    "stream": true
  }'

Gestreamde antwoorden retourneren factureringsbewijs in X-Archibot-*-antwoordheaders in plaats van elk gebeurtenisfragment te herschrijven.

OpenAI-compatibele modelontdekking gebruikt dezelfde bearer-sleutel:

curl https://chat.example.archibot.cloud/v1/models \
  -H "Authorization: Bearer $ARCHIBOT_API_KEY"

Modelontdekking put niet uit je gebruikstegoed.

Snelheidslimieten

Gegenereerde API-sleutels hebben een verzoeklimiet per sleutel. Antwoorden bevatten de headers X-RateLimit-Limit, X-RateLimit-Remaining en X-RateLimit-Reset. Wanneer de limiet wordt overschreden, retourneert het endpoint 429 met een Retry-After-header.

Verloop

Gegenereerde API-sleutels verlopen één jaar na de aanmaak. Elke sleutelrij toont de datums van aanmaak, verloop en laatste gebruik naast het sleutelprefix.

Verlopen sleutels blijven zichtbaar op naam, prefix en metadata zodat je oude integraties kunt controleren, maar ze kunnen geen modelontdekking of het responses-endpoint meer aanroepen. Afwijzingen van verlopen sleutels gebeuren voordat er gebruik wordt geteld. Roteer een verlopen sleutel om een vervanging onder dezelfde naam en hetzelfde bereik uit te geven, of trek deze in als de integratie buiten gebruik wordt gesteld.

Een sleutel roteren

Roteer een sleutel wanneer een integratie onder dezelfde naam en hetzelfde bereik moet blijven werken, maar de geheime waarde moet veranderen.

Vind op het tabblad API Keys de actieve sleutel op naam of prefix.
Kies Rotate op die sleutelrij.
Kopieer de vervangende waarde uit de eenmalige melding.
Werk het betrokken script, de secret manager-vermelding of de runtime-omgeving bij.

Rotatie trekt de vorige sleutel in en maakt een vervanging met dezelfde naam en hetzelfde bereik. De vervangende waarde wordt slechts eenmaal getoond, in dezelfde melding die voor nieuwe sleutels wordt gebruikt. Rotatie werkt onmiddellijk; er is geen apart bevestigingsvenster, dus wees klaar om de integratie bij te werken voordat het oude verkeer mislukt.

Een sleutel intrekken

Trek een sleutel in wanneer:

Deze niet meer wordt gebruikt.
Deze is geplakt in een chat, e-mail, ticket, repository of gedeeld document.
De eigenaar het team verlaat.
De integratie wordt vervangen.

Vind op het tabblad API Keys de sleutel op naam of prefix.
Kies Revoke op die sleutelrij.
Werk elk script of elke integratie die ervan afhankelijk was bij of verwijder het.

Intrekken gaat onmiddellijk in en er is geen apart bevestigingsvenster, dus bevestig dat het de juiste sleutel is voordat je Revoke kiest.

Facturering

Gegenereerde API-sleutels putten uit hetzelfde gedeelde chat- en API-gebruikstegoed dat in Billing wordt getoond. Mislukte preflight-controles en afgewezen upstream-verzoeken horen geen tegoed te verbruiken; een gestreamd verzoek wordt factureerbaar zodra het Archibot-endpoint de stream accepteert. Zie ArchibotChat-facturering en tegoed.

Beveiligingsregels

Commit API-sleutels nooit naar versiebeheer.
Plak API-sleutels nooit in supporttickets of gedeelde documenten.
Gebruik omgevingsvariabelen of een secret manager, geen inline-waarden.
Gebruik waar mogelijk één sleutel per integratie.
Roteer sleutels regelmatig voor langlopende integraties.
Trek een sleutel onmiddellijk in als blootstelling wordt vermoed.

Chat-referentie versus API-sleutel

Referentie	Zichtbaar voor gebruiker	Gebruikt voor
Verborgen chat-referentie	Nee	Chat-scherm in de browser
Gegenereerde API-sleutel	Ja, eenmaal	Scripts, lokale agent-tools en endpoint-integraties

Vraag de ISM-support niet om de verborgen chat-referentie te onthullen. Deze is met opzet niet zichtbaar voor de gebruiker.

Gerelateerde gidsen

Klaar wanneer

API-toegang is ingeschakeld voor het account.
De gegenereerde sleutelwaarde wordt gekopieerd en opgeslagen voordat je het tabblad verlaat.
Integraties verwijzen naar de ArchibotChat-endpoint-URL die voor het account is verstrekt.