Authentication
MorphのAPIを利用するには、APIキーをリクエストのヘッダーに含める必要があります。APIキーはMorphのダッシュボードから取得でき、セキュアなアクセスを保証します。
APIキーの取得方法
- Morph画面のトップページから「Secrets」タブを押下して下記のページを表示します。
- 次に「Create Secret」のボタンを押下し、適当なSecret nameとSource IPを入力して「Create」ボタンで確定します。 ※Source IPを空欄にすると全部のIPが許可されます。Source IPを限定する場合はカンマ区切りで入力してください。
- 作成したAPIキーが不要になった場合は「Delete」ボタンから削除することができます。
- 出現した削除確認モーダルから「Delete」ボタンを押下すると、APIキーは完全に削除されます。 [NB!] この操作は取り消すことができません。一度削除すると復旧できないため十分にご注意ください。
API URL
APIのURLは以下のような形式となります。
BaseURL: https://beta-api.morphdb.io/v0/rest/[Your_DatabaseID]/
データベースID([Your_DatabaseID])の確認方法
Morph画面のトップページでブラウザのURLバーをご確認ください。URLの最後にUUID (opens in a new tab)の文字列が続きます。そちらがお客様のデータベースIDとなります。
なお、データベーススキーマ内の特定のテーブルに対するクエリを行う場合は、APIのURLは以下のような形式となります。
URL: https://beta-api.morphdb.io/v0/rest/[Your_DatabaseID]/[Your_Table_Slug]
テーブルスラグ([**Your_Table_Slug**])の確認方法
Morph画面のトップページ左側のサイドメニューでデータベースのアイコンが付いているものがデーブルで、テーブルスラグがテーブル名として表示されています。
下記の例の場合はsample_tableがテーブルスラグとなります。sample_table に対してAPIリクエストを送る場合は[Your_Table_Slug] にsample_table を設定します。
Example
以下にcURLコマンドを使用してAPIにアクセスする例を示します：
上記の[Your_DatabaseID], [Your_Table_Slug], [Your_API_Key] はお客様の環境によって異なるため以下の方法で取得して置換してください。