Autentizace

Používání Meshy API vyžaduje autentizaci. Tento návod vám ukáže, jak si vytvořit účet a API klíče.

API klíče

Vytvoření účtu Meshy

Meshy API vyžaduje, abyste měli účet Meshy pro vytváření a správu API klíčů. Pokud je požadavek na API proveden bez API klíče, API odpoví chybou neplatných přihlašovacích údajů.

Účet Meshy si můžete vytvořit návštěvou oficiálních webových stránek Meshy a registrací.

Vytvoření API klíčů

Jakmile si vytvoříte účet Meshy, můžete vytvářet API klíče na stránce API Keys ve vývojářské platformě.

Můžete vytvořit více API klíčů pro různé účely. Například můžete vytvořit jeden API klíč pro vaši iOS aplikaci a druhý pro vaši webovou aplikaci. Používání každého API klíče je sledováno odděleně a kdykoli je můžete odvolat.

Pro kterýkoli klíč můžete také nastavit měsíční limit kreditu, čímž omezíte, kolik může utratit bez ohledu na celkové využití vašeho účtu — což je užitečné pro omezení klíče, který předáváte dodavateli nebo konkrétnímu prostředí.

Dialogové okno Create API Key s volitelným polem pro měsíční limit kreditu

Chcete-li vytvořit API klíč, klikněte na tlačítko Create API Key na stránce API a poté zadejte název pro svůj API klíč.

Jakmile vytvoříte API klíč, zobrazí se vám hodnota API klíče. Hodnotu API klíče si můžete zkopírovat a uložit na bezpečné místo.

Tuto hodnotu API klíče už znovu neuvidíte.

Používání API klíčů

Jakmile vytvoříte API klíč, můžete jej použít k autentizaci svých požadavků na Meshy API. API klíč můžete API předat v hlavičce Authorization, příklad hlavičky je uveden níže.

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Předpona Bearer v hodnotě hlavičky je povinná pro programovou komunikaci s Meshy API. Více se o tom můžete dozvědět na IETF RFC 6750

Zabezpečení

Zabezpečení bereme ve společnosti Meshy velmi vážně a usilovně pracujeme na tom, aby Meshy API bylo bezpečné. Doufáme, že vaše data a data vašich uživatelů jsou u nás v bezpečí. Zde je několik obecných doporučení, která vám pomohou chránit vaše data a požadavky při používání Meshy API, ale ujistěte se prosím, že dodržujete také pravidla praktikovaná ve vašem týmu nebo na pracovišti.

Zabezpečení přenosové vrstvy

Zatímco vaše data jsou šifrována v klidovém stavu, jakmile jsou uložena v Meshy, Meshy API používá a vynucuje TLS pro šifrování dat při přenosu. To znamená, že všechny požadavky do a z Meshy API jsou odesílány přes HTTPS a jakýkoli požadavek odeslaný přes HTTP obdrží stavový kód 301 Moved Permanently. Ačkoli to není doporučeno, v některých případech, pokud musíte komunikovat přes HTTP, musíte svému HTTP klientovi explicitně nařídit, aby sledoval přesměrování z HTTP na HTTPS. Zde jsou příklady:

Sledování přesměrování z HTTP na HTTPS

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

Přesměrování fungují pouze pro požadavky GET: HTTP klienti opakovaně odesílají přesměrovaný požadavek POST jako GET bez jeho těla, takže při vytváření úloh vždy volejte přímo https://.

Bezpečnost API klíčů

Vezměte prosím na vědomí, že ani členové týmu Meshy pro vás nemohou zobrazit nebo obnovit odvolané API klíče!

Jakmile je API klíč vygenerován, již není viditelný v dashboardu, proto si jej prosím stáhněte a uchovávejte v bezpečí, protože kdokoli, kdo jej získá, jej může použít ke komunikaci s Meshy API vaším jménem. Pokud se domníváte, že byl váš API klíč kompromitován, můžete jej kdykoli odvolat z dashboardu, jakmile je odvolán, přestane být platný.

Zveřejnění bezpečnostního problému

Pokud se domníváte, že jste objevili bezpečnostní problém v Meshy API, prosím kontaktujte nás. Vážíme si vašeho zodpovědného přístupu ke zveřejnění a vynaložíme veškeré úsilí, abychom váš přínos ocenili.