Authentication

Ang paggamit ng Meshy API ay nangangailangan ng authentication. Ipapakita sa gabay na ito kung paano gumawa ng account at mga API key.

API Keys

Paggawa ng Meshy Account

Hinihingi ng Meshy API na mayroon kang Meshy account upang makagawa at mamahala ng mga API key. Kung may request na ginawa sa API nang walang API key, ang API ay tutugon ng invalid credentials error.

Maaari kang gumawa ng Meshy account sa pamamagitan ng pagbisita sa opisyal na website ng Meshy at pagpaparehistro.

Paggawa ng mga API Key

Kapag nakagawa ka na ng Meshy account, maaari kang gumawa ng mga API key sa pahina ng API Keys sa Developer Platform.

Maaari kang gumawa ng maraming API key para sa iba't ibang layunin. Halimbawa, maaari kang gumawa ng isang API key para sa iyong iOS app at isa pa para sa iyong web app. Ang paggamit ng bawat API key ay sinusubaybayan nang hiwalay, at maaari mo itong bawiin anumang oras.

Maaari ka ring magtakda ng buwanang credit limit sa anumang key, na naglilimita kung gaano karami ang magagastos nito anuman ang kabuuang paggamit ng iyong account — kapaki-pakinabang para sa paglilimita sa isang key na ibinibigay mo sa isang contractor o sa isang partikular na environment.

Upang gumawa ng API key, i-click ang button na Create API Key sa pahina ng API, at pagkatapos ay ilagay ang isang pangalan para sa iyong API key.

Kapag nakagawa ka na ng API key, ipapakita sa iyo ang value ng API key. Maaari mong kopyahin ang value ng API key at itago ito sa isang ligtas na lokasyon.

Hindi mo na muling makikita ang value ng API key na ito.

Paggamit ng mga API Key

Kapag nakagawa ka na ng API key, maaari mo itong gamitin upang i-authenticate ang iyong mga request sa Meshy API. Maaari mong ipasa ang iyong API key sa API sa Authorization header, ang isang halimbawang header ay ipinapakita sa ibaba.

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Security

Napakaseryoso namin ang security dito sa Meshy, at nagsusumikap kami upang matiyak na ligtas ang Meshy API. Umaasa kami na ligtas sa amin ang iyong data at ang data ng iyong mga user. Narito ang ilang mataas na antas na mga gabay upang matulungan kang panatilihing ligtas ang iyong data at mga request kapag gumagamit ng Meshy API, ngunit mangyaring tiyakin din na sundin ang mga gabay na sinusunod sa iyong team o lugar ng trabaho.

Transport Layer Security

Habang ang iyong data ay naka-encrypt at nasa rest sa sandaling naitabi na ito sa Meshy, ang Meshy API ay gumagamit at nagpapatupad ng TLS, upang i-encrypt ang data habang ito ay ipinapadala. Ibig sabihin, lahat ng mga request patungo at mula sa Meshy API ay ipinapadala sa pamamagitan ng HTTPS, at anumang request na ginawa sa HTTP ay makakakuha ng status code na 301 Moved Permanently. Bagama't hindi inirerekomenda, sa ilang mga kaso, kung kailangan mong makipag-usap sa HTTP, kailangan mong tahasang sabihin sa iyong HTTP client na sundin ang mga redirection mula HTTP patungo sa HTTPS. Narito ang ilang halimbawa:

# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Gumagana lamang ang mga redirect para sa mga GET request: ang mga HTTP client ay muling magpapadala ng na-redirect na POST bilang isang GET nang walang body nito, kaya palagi mong direktang tawagan ang https:// kapag gumagawa ng mga task.

Kaligtasan ng API Key

Kapag nalikha na, ang mga API key ay hindi na makikita sa dashboard, kaya mangyaring i-download at panatilihin itong ligtas at secure dahil kahit sino na makakuha nito ay maaaring gamitin ito upang makipag-usap sa Meshy API sa ngalan mo. Kung sa tingin mo ay nakompromiso ang iyong API key, maaari mo itong bawiin anumang oras mula sa dashboard, kapag nabawi na, hindi na ito magiging balido.

Security Disclosure

Kung sa tingin mo ay nakatuklas ka ng isang isyu sa security sa Meshy API, mangyaring makipag-ugnayan sa amin. Pinahahalagahan namin ang iyong responsableng disclosure at gagawin namin ang aming makakaya upang kilalanin ang iyong mga kontribusyon.