The Bubble API – Data API endpoints(エンドポイント)
概要
Data API 使用時に正しいエンドポイントを特定する方法を説明します。
API エンドポイントの確認場所
Settings → API にて確認できます。
Data API の Root URL 形式
アプリのエンドポイントは以下の形式となります:
- 独自ドメインを未設定の場合:https://appname.bubbleapps.io/api/1.1/obj/typename
- 独自ドメインを設定している場合:https://yourdomain.com/api/1.1/obj/typename
| 変数 | 内容 | 補足 |
|---|---|---|
| appname | アプリ名 | 独自ドメイン未設定時に使用 |
| yourdomain.com | アプリのドメイン | 独自ドメイン設定済みの場合 |
| typename | データタイプ名 | 小文字&スペース削除で指定 |
アプリのブランチと Data API URL
アプリのブランチごとに URL が異なります。
Developer(開発環境)
ブランチ ID を含む URL となります。
- Mainブランチ → version-test
- その他カスタムブランチ → それぞれ固有のブランチID
例:
https://appname.bubbleapps.io/version-test/api/1.1/obj/typename
または
https://yourdomain.com/version-test/api/1.1/obj/typename
Settings → API に表示される URL も現在作業中のブランチに対応しています。
Live(本番環境)
https://yourdomain.com/api/1.1/obj/typename
または
https://appname.bubbleapps.io/api/1.1/obj/typename
typename について
URL 中の typename は、アクセスするデータタイプ名を URL フレンドリーに変換したものです。
変換ルールは下記です。
- すべて小文字
- スペースを削除
※例
データタイプ名 : Rental Unit
typename : rentalunit
エンドポイント :https://appname.bubbleapps.io/api/1.1/obj/rentalunit
注意
データタイプ名が一意でない場合、API は最初に一致したデータタイプのみ返します。
Data API を利用する場合、タイプ名はユニークにすることを推奨します。