Naar inhoud springen
Handleidingen
Handleidingen

Snelstart

Maak standaard API-sleutels en beveiligingsregels aan en beheer ze met een RunAPI-beheerssleutel.

Platformbeheer stelt accountbeheerders in staat om standaard API-sleutels en beveiligingsrichtlijnen aan te maken, in te zien, bij te werken en in te trekken zonder voor elke wijziging het dashboard te gebruiken.

Een beheerssleutel aanmaken

Volg de Authenticatie-handleiding om u aan te melden, open vervolgens de pagina Beheerssleutels en maak een beheerssleutel aan. Bewaar hem apart van standaard applicatiesleutels. Stuur hem als bearer-token uitsluitend naar Platform Management-eindpunten.

HTTP
Authorization: Bearer YOUR_MANAGEMENT_KEY

Een standaard API-sleutel kan geen eindpunten voor sleutel- of guardrailbeheer aanroepen. Een geldige beheersleutel kan toch 403 Forbidden ontvangen wanneer de eigenaar niet langer de vereiste accountrol heeft.

Standaard API-sleutels weergeven

Gebruik GET /api/v1/keys om sleutels te inspecteren die zichtbaar zijn voor het account van de beheersleutel:

SHELL
curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

Gebruik geretourneerde publieke identifiers voor latere ophaal-, bijwerk-, intrek- of guardrail-toewijzingsverzoeken. Leid nooit toegang af uit een sleutelnaam of gemaskerd token.

Een sleutel aanmaken en roteren

Maak een applicatiesleutel aan met POST /api/v1/keys. Het volledige geheim wordt alleen geretourneerd in de aanmaakreactie; sla het op in uw geheimenbeheerder voordat u die reactie verwijdert. Bij rotatie dient u een vervangend sleutel aan te maken, deze in de applicatie te implementeren, het verkeer te verifiëren en vervolgens de oude sleutel in te trekken.

SHELL
curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows accepteert elke combinatie van doorlopende bestedingslimieten voor 1h, 1d en 7d. Als een geconfigureerd venster uitgeput is, retourneren aanroepen met die sleutel 429 Too Many Requests totdat het gebruik buiten het venster valt. Stuur een leeg object bij het bijwerken van een sleutel om alle doorlopende limieten te wissen.

Guardrails toepassen

Guardrails zijn herbruikbaar accountbeleid voor model-, provider- en bestedingscontroles. Beheer beleid via /api/v1/guardrails en gebruik vervolgens /api/v1/guardrail_assignments om ze te koppelen of te verwijderen. Behandel een geweigerde toewijzing als een beleids- of eigendomsfout in plaats van stil door te gaan zonder de guardrail.

Beheerfouten afhandelen

  • 401 Unauthorized betekent dat de referentie ontbreekt, ongeldig van opmaak is, ingetrokken is of niet geldig is.
  • 403 Forbidden betekent dat de referentieklasse of accountrol de bewerking niet mag uitvoeren.
  • 404 Not Found betekent dat de gevraagde resource niet zichtbaar is voor het geverifieerde account.
  • 422 Unprocessable Content betekent dat een of meer ingediende waarden een resourceregel schenden.