Ga naar inhoud

Authenticatie en API-sleutels

Maak een sk_ API-sleutel aan in het API-centrum . De volledige sleutel wordt slechts één keer weergegeven, bij het aanmaken of roteren.

Gebruik voor elke applicatie, omgeving en geautomatiseerde taak een aparte sleutel, zodat elk zijn eigen budget kan hebben en onafhankelijk kan worden uitgeschakeld, geroteerd en geaudit.

Aanbevolen:

X-API-Key: sk_your_key

De standaard Bearer-vorm werkt ook:

Authorization: Bearer sk_your_key

Stuur slechts één van de twee in een verzoek.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Een sleutel werkt voor het account dat hem heeft aangemaakt: hij kan de services aanroepen die dat account mag gebruiken en heeft alleen toegang tot de resources van dat account. Een sleutel kan het aanmeldings-e-mailadres, wachtwoord, telefoonnummer of profiel niet wijzigen en kan geen API-sleutels aanmaken, roteren of intrekken.

Optionele limieten:

  • allowed_engines: alleen de vermelde vertaalinstellingen; een lege array voegt geen limiet op sleutelniveau toe.
  • expires_at: verloopdatum.
  • quota_limit: het levensbudget van de sleutel in hele millicredits; 0 stelt geen budget op sleutelniveau in, en de credits van de account worden zoals gebruikelijk vereffend.

Maak sleutels aan, wijzig hun limieten, roteer of intrek ze in het /API-centrum . Zodra een sleutel is ingetrokken, uitgeschakeld of verlopen, of wanneer het bijbehorende account is uitgeschakeld, falen nieuwe verzoeken onmiddellijk.

Rotatie maakt een nieuw geheim aan en schakelt het oude onmiddellijk uit; de nieuwe sleutel behoudt de oorspronkelijke limieten en het reeds gebruikte budget. Een verlopen sleutel kan niet worden geroteerd; maak een nieuwe aan. Voor een soepele overgang maakt u een nieuwe sleutel aan en implementeert u deze, bevestigt u dat oproepen slagen en intrekt u vervolgens de oude sleutel.

  • Bewaar sleutels uitsluitend op de server of in een gecontroleerde runtime.
  • Gebruik omgevingsvariabelen of een geheimenbeheerder; plaats sleutels nooit in broncode, logbestanden, browserpakketten of openbare opslagplaatsen.
  • Stuur nooit de sleutel naar upload- of downloadadressen die door de API worden geretourneerd.
  • Log de sleutel-ID, verzoek-ID en bewerking-ID; log nooit de volledige sleutel.
  • Als een sleutel lekt, roteer deze dan onmiddellijk en controleer de bijbehorende taken en kosten.