BroadRouter
Magsimula

API key

Na-update

Ang API key ay isang lihim na string na kumikilala at nagpapahintulot sa client na tumatawag sa isang API. Kadalasang hinihingi ito ng mga LLM API sa Authorization: Bearer header, at ang sinumang may hawak ng key ay makakagawa ng mga request na sisingilin sa account na may-ari nito.

Tinatawag ding: key, API token, secret key, bearer token, inference key

Parang password para sa isang program ang API key. Awtoridad din ito sa paggastos: ang sinumang may hawak nito ay magagamit ang balance mo.

Paano ito gumagana

Itinuturing ng mga LLM API ang key bilang bearer token. Ipinapadala ito ng client sa bawat request:

curl https://inference.broadnet.ai/v1/models \
  -H "Authorization: Bearer $BROADNET_API_KEY"

Ayon sa RFC 6750, ang bearer token ay token na magagamit ng “any party in possession of the token” (Salin ng BroadRouter: “sinumang may hawak ng token”). Walang second factor. Kaya sinasabi rin ng parehong RFC na dapat laging ipadala ng mga client ang bearer token sa TLS (https://).

Hinahanap ng provider ang key, tinutukoy ang account, sinusuri ang mga limit at policy, saka sine-serve o tinatanggihan ang request. Kadalasang 401 ang ibinabalik kapag wala o mali ang key; kadalasang 403 naman kapag tinanggihan ng policy ang key, gaya ng IP allow list.

Bakit ito mahalaga

Ang na-leak na key ang isa sa pinakakaraniwang dahilan ng biglang paglobo ng API bill, dahil may mga bot na nag-i-scan ng public code para sa mga secret. Puwede rin itong maglantad ng data kung naaabot ng key ang mga endpoint na nagbabalik ng detalye ng account. Mabuting gawi, ayon sa OWASP secrets guidance:

  • I-load ang mga key mula sa environment variable o secrets manager. Huwag kailanman i-commit ang mga ito o isama sa container image.
  • Bigyan ng sariling key ang bawat app o agent, para ma-revoke mo ang isa nang hindi pinapahinto ang lahat.
  • I-rotate ang mga key ayon sa iskedyul, at agad-agad pagkatapos ng anumang hinihinalang leak.
  • Limitahan kung saan gumagana ang key, halimbawa gamit ang allow list ng mga server IP.

Sa BroadNet Inference

Dalawang credential ang pinaghihiwalay ng BroadNet. Ang inference key ay tumatawag sa mga model sa /v1/*. Ang portal credential naman ay nag-o-automate ng account: mga key, pinapayagang IP at mga pagbili. Ituring ang pangalawa bilang buong awtoridad sa account.

Isang beses lang ipinapakita ang dalawa. SHA-256 hash lang ang itinatago ng BroadNet, kaya hindi na nito maipapakita ulit ang key. Tumatagal nang isang taon ang isang pay-as-you-go key, at hanggang sampung aktibong key ang puwede sa isang account. Puwedeng may sariling listahan ng pinapayagang IP ang bawat key. Pagkatapos ng revocation o pagbabago sa allow-list, humihinto ang mga bagong request sa loob ng limang segundo.

Hiwalay ang mga plan key para sa mga flat-rate plan at hindi kailanman bumabawas sa balance mo. Nasa API keys at IP allow lists ang mga hakbang sa setup, at nasa errors at retries ang mga status code.

Mga karaniwang pagkakamali

  • Pag-log ng buong request headers. Naisusulat nito ang key sa mga log mo.
  • Paggamit ng iisang key sa buong team. Hindi mo na mare-revoke ang access ng isang tao lang.
  • Pagpapadala ng key sa support. Ipadala na lang ang value ng X-Request-ID header.

Mga tanong

Puwede ko bang ilagay ang LLM API key sa browser o mobile app?

Hindi. Makukuha ang kahit anong ipinapadala sa client. Itago ang key sa server, at ipatawag sa app mo ang server mo, na siyang tatawag sa LLM API.

Ano ang dapat kong gawin kung na-leak ang key?

I-revoke agad ito, gumawa ng bago, at suriin ang usage sa panahong nakalantad ito. Pagkatapos, alamin kung paano ito na-leak, halimbawa sa isang commit, log line o screenshot.

Ilang key ang puwede kong magkaroon sa BroadNet Inference?

Hanggang sampung aktibong pay-as-you-go key kada account. Tumatagal ang bawat isa nang isang taon mula nang gawin. Hiwalay ang mga plan key.

Basahin bilang MarkdownTanungin ang ChatGPTTanungin ang ClaudeTanungin ang Perplexity