Burime · Autentikimi

Dokumentacioni për Autentikimin dhe Fushën e Aksesit

Udhëzues i gatshëm për prodhim për autentifikimin JWT/sesioni, autentifikimin me çelës API, header-at e fushës, kontekstin e hapësirës së punës, dhe rregullat e validimit.

Kthehu te Dokumentacioni Shko te Metodat e Autentifikimit

Metodat e Autentifikimit

Autentifikimi JWT/sesioni për kërkesat në kontekstin e përdoruesit.
Autentifikimi me çelës API për shërbim-në-shërbim dhe integrime të kontrolluara.

Header-at e kërkuara

Authorization: Bearer [jwt_token] OSE X-API-Key: [api_key]Content-Type: application/jsonX-Scope-Type: personal | workspaceX-Workspace-ID: i kërkuar vetëm në fushën e hapësirës së punës

Modeli i Fushës

Fusha personale ekzekutohet nën kontekstin e përdoruesit të autentikuar.
Fusha e hapësirës së punës ekzekutohet nën një hapësirë pune specifike me kontrolle të bazuara në role.

Rregullat e Validimit

Nëse fusha është personale, X-Workspace-ID nuk duhet të jepet.
Nëse fusha është e hapësirës së punës, X-Workspace-ID është i kërkuar.
Header-at e fushës të pavlefshëm ose konfliktues kthejnë 422.

Shembull i Autentifikimit JWT

bash

curl -X POST "/api/v1/chat/completions" \
  -H "Authorization: Bearer [jwt_token]" \
  -H "Content-Type: application/json" \
  -H "X-Scope-Type: personal" \
  -d '{
    "message":"Hello from JWT auth",
    "stream":false
  }'

Shembull i Autentifikimit me Çelës API

bash

curl -X POST "/api/v1/chat/completions" \
  -H "X-API-Key: [api_key]" \
  -H "Content-Type: application/json" \
  -H "X-Scope-Type: workspace" \
  -H "X-Workspace-ID: [workspace_uuid]" \
  -d '{
    "message":"Hello from API key auth",
    "stream":false
  }'

Fusha e Hapësirës së Punës

json

{
  "headers": {
    "X-Scope-Type": "workspace",
    "X-Workspace-ID": "[workspace_uuid]"
  },
  "note": "Workspace scope requires workspace id."
}

Fusha Personale

json

{
  "headers": {
    "X-Scope-Type": "personal"
  },
  "note": "Personal scope must not include workspace id."
}

Modelet e Gabimit

401

Autentifikimi mungon, ka skaduar, ose është i pavlefshëm.

403

Fusha nuk lejohet ose kufizim i rolit në hapësirën e punës.

422

Validimi i header-it/kontekstit dështoi.

429

Kufiri i kërkesave u tejkalua për kontekstin aktual të autentifikimit.