Mag-authenticate gamit ang API key

Nag-a-authenticate ang CLEVI gateway sa mga path na compatible sa OpenAI at Anthropic gamit ang iisang API key.
Dalawa ang value na kailangang i-set sa client: ang authentication header na paglalagyan ng key at ang base URL ng SDK. Magkakaiba ang mga pinapahintulutang format ng header at base URL depende sa specification.
Pagkatapos makumpleto ang setup, maaari mong agad na i-verify kung matagumpay ang authentication sa pamamagitan ng pagkuha sa listahan ng mga modelo.
Nagbabalik ito ng 401 kapag nabigo ang authentication, at 403 kapag matagumpay ang authentication ngunit hindi natutugunan ang mga kondisyon sa pahintulot o limitasyon.

Mag-isyu ng API key sa screen ng API keys sa console. Maaari mo ring pamahalaan ang pagbawi ng key at saklaw ng paggamit nito sa parehong screen.

Authentication header

Sa parehong specification, inilalagay ang API key sa isang request header. Gamitin ang alinman sa X-API-Key header o Authorization header; nag-iiba ang pinapahintulutang format depende sa specification.

Kapag ginagamit ang Authorization header sa path na compatible sa OpenAI, kailangan ang Bearer prefix. Kapag ipinadala lamang ang key nang walang prefix, tatanggihan ng gateway ang request.

Hindi case-sensitive ang mga pangalan ng header, kaya gagana rin nang walang pagbabago ang x-api-key header na ipinapadala ng Anthropic SDK. Kapag parehong tinukoy ang dalawang header, uunahin ang value ng X-API-Key.

base URL

Magagamit mo pa rin ang dati mong SDK sa pamamagitan lamang ng pagpapalit ng base URL sa address sa ibaba. Magkaiba ang dalawang address kung kasama ang /v1, kaya itakda ang address na tumutugma sa specification.

Pag-verify ng authentication

Pagkatapos itakda ang key at base URL, maaari mong kumpirmahin kung awtorisado ka sa pamamagitan ng pagkuha ng listahan ng mga modelo. Isinasagawa ng mga halimbawa sa ibaba ang parehong request gamit ang curl, OpenAI SDK, at Anthropic SDK. Ilagay ang key na ibinigay sa screen ng API key sa lugar ng sk-....

Kapag kumukuha gamit ang curl, tukuyin ang buong path hanggang /v1/models para sa parehong format. Ginagamit ng unang command ang X-API-Key header sa OpenAI-compatible na path, at ng pangalawang command ang Authorization header sa Anthropic-compatible na path.

curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
  -H "X-API-Key: sk-..."

curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
  -H "Authorization: Bearer sk-..." \
  -H "anthropic-version: 2023-06-01"

Sa OpenAI SDK, tukuyin ang address na may kasamang /v1 sa base_url.

from openai import OpenAI

client = OpenAI(
    api_key="sk-...",
    base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)

for model in client.models.list():
    print(model.id)

Sa Anthropic SDK, tukuyin ang base_url na nagtatapos bago ang /v1.
Para sa authentication, gamitin nang eksakto ang x-api-key header na ipinapadala ng SDK.

from anthropic import Anthropic

client = Anthropic(
    api_key="sk-...",
    base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)

for model in client.models.list(limit=20).data:
    print(model.id)

Kung 200 ang response sa alinmang halimbawa, matagumpay ang authentication, at naglalaman ang data ng response ng listahan ng mga modelong maaaring tawagin gamit ang key na ito. Kung 401 ang response, suriin ang sanhi ayon sa pagkakasunod sa susunod na seksyon.

Nabigo ang authentication

Kung walang key o expired o revoked na key ang ipinadala, magbabalik ito ng 401. Kapag tumawag nang walang key sa OpenAI-compatible na path, ibinabalik ang body sa ibaba; sa Anthropic-compatible na path, ang error.type ay authentication_error.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

Kung nakatanggap ka ng 401, suriin ito sa sumusunod na pagkakasunod-sunod.

1. Suriin ang status ng key sa screen ng API key. Kung expired o revoked ang key, gumawa ng bago.
2. Suriin kung X-API-Key o Authorization ang pangalan ng header.
3. Kung gagamit ka ng Authorization header sa OpenAI-compatible na path, tiyaking may Bearer prefix ito.

Pagkatapos ng mga pagbabago, isagawa muli ang pagkuha ng listahan ng mga modelo sa seksyong Kumpirmahin ang authentication at tiyaking 200 ang natatanggap.

Mga header na ginagamit nang magkakasama

Opsyonal ang lahat ng sumusunod na header. Inirerekomenda naming itakda ang X-Request-Id upang masubaybayan ang mga problema.

Kung paulit-ulit na nagkakaroon ng 5xx, ipaalam ito sa Help at Contact kasama ang X-Request-Id. Kung ikaw mismo ang tumukoy ng value, maaari itong direktang itugma sa tala ng kliyente.