認証

Meshy APIを使用するには認証が必要です。このガイドでは、アカウントとAPIキーの作成方法を説明します。

API Keys

Meshyアカウントの作成

Meshy APIを利用するには、APIキーを作成・管理するためのMeshyアカウントが必要です。APIキーを付与せずにAPIへリクエストを行うと、APIは無効な認証情報のエラーを返します。

Meshyアカウントは、Meshy公式サイトにアクセスして登録することで作成できます。

APIキーの作成

Meshyアカウントを作成したら、Developer Platform内のAPI KeysページでAPIキーを作成できます。

用途に応じて複数のAPIキーを作成できます。例えば、iOSアプリ用に1つ、ウェブアプリ用に別のAPIキーを作成することができます。各APIキーの使用状況は個別に追跡され、いつでも取り消すことができます。

また、いずれのキーにも月間クレジット上限を設定でき、アカウント全体の使用状況にかかわらず、そのキーが消費できるクレジット量を制限できます。これは、契約先の担当者や特定の環境にキーを渡す際に、使用量を制限したい場合に便利です。

APIキーを作成するには、APIページのCreate API Keyボタンをクリックし、APIキーの名前を入力してください。

APIキーを作成すると、APIキーの値が表示されます。このAPIキーの値をコピーして、安全な場所に保管してください。

このAPIキーの値は二度と表示されません。

APIキーの使用

APIキーを作成したら、それを使ってMeshy APIへのリクエストを認証できます。APIキーはAuthorizationヘッダーでAPIに渡すことができます。以下にヘッダーの例を示します。

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Security

Meshyではセキュリティを非常に重視しており、Meshy APIが安全であるよう努めています。皆様のデータとユーザーのデータが安全に守られることを願っています。 ここでは、Meshy APIを使用する際にデータとリクエストを安全に保つための大まかなガイドラインをご紹介しますが、ご自身のチームや職場で実践されているガイドラインにも従うようにしてください。

トランスポート層セキュリティ

Meshyに保存されたデータは保存時に暗号化されますが、Meshy APIは通信中のデータを暗号化するためにTLSを使用し、その利用を強制しています。 つまり、Meshy APIへのリクエストとMeshy APIからのレスポンスはすべてHTTPS経由で送信され、HTTP経由で行われたリクエストには301 Moved Permanentlyステータスコードが返されます。推奨はされませんが、 場合によってはHTTPで通信する必要がある場合、HTTPからHTTPSへのリダイレクトに従うようHTTPクライアントに明示的に指示する必要があります。以下にいくつかの例を示します。

# use `-L` to follow HTTP to HTTPS redirections
curl -L -X 'POST' \
  https://api.meshy.ai/openapi/v1/text-to-texture

APIキーの安全性

一度発行されたAPIキーは、ダッシュボード上では二度と表示されません。そのため、必ずダウンロードして安全かつ厳重に保管してください。APIキーを入手した者は誰でも、それを使ってあなたに代わってMeshy APIとやり取りできてしまいます。APIキーが漏洩したと思われる場合は、ダッシュボードからいつでも取り消すことができます。 一度取り消すと、そのキーは無効になります。

セキュリティに関する報告

Meshy APIにセキュリティ上の問題を発見された場合は、ご連絡ください。責任ある情報開示に感謝するとともに、皆様のご貢献を認識できるよう最善を尽くします。