ForePaaS Store API リファレンス
Warning
このページでは、ForePaaS レガシープラットフォームについて説明しています。このプラットフォームは、新規登録を受け付けていません。OVHcloud Data Platformを使用している場合は、最新のドキュメントを参照してください。
ForePaaS Storeは、プラットフォーム上のコラボレーションスペースで、各組織のメンバーがコードテンプレートやパッケージを作成、共有、またはアクセスできます。
各マーケットプレイス（アプリケーションテンプレート、API拡張機能など）には独自のエンドポイントがあります。すべてのエンドポイントは以下から始まります。
https://store.forepaas.io/
認証トークンを取得した後、ストアにパッケージを作成するには2つのステップが必要です：
- 正しいマーケットプレイスにパッケージを作成する
- 最初のバージョンのコードを含むZIPファイルをアップロードする
同じAPIエンドポイントを使用して、パッケージ情報とバージョンを更新できます。
Warning
現在、アプリケーションテンプレートとAPIテンプレートのみが完全にサポートされています。
認証トークンの取得
以下に参照されている各呼び出しには、認証トークンが必要です。
!> ForePaaSアカウントを持っており、少なくとも1つの組織に属している必要があります。パッケージとバージョンをアップロードできるようになります。
認証トークンを取得するには、
- ForePaaSプラットフォームを開き、プロジェクトを開きます
- ブラウザーコンソールを開きます（Google ChromeではCtrl + Shift + C）
- アプリのパネルから、+を選択して新しいアプリケーションダイアログボックスを開きます
- ブラウザーコンソールでネットワークタブを開き、store.forepaas.ioでフィルタリングします
https://store.forepaas.io/v1用のGETが1つあるはずです- 右クリックしてcURLとしてコピーを選択します。これは認証トークンを含み、次回のストアAPI呼び出しの基礎となります。
パッケージの作成または更新
プライベートストアにパッケージを作成/更新します。つまり、組織のメンバーのみがそれを見ることができます。
現在、パッケージをパブリックストアにアップロードすることはできません。
以下のリファレンスでは、Appテンプレート用のパッケージをアップロードする方法を示します。他のマーケットプレイスのすべてのAPIのリストは以下を参照してください。
リクエスト例
curl 'https://store.forepaas.io/v1/packages/app/templates/my-app' \
-X 'PUT' \
-H 'authority: store.forepaas.io' \
-H 'accept: application/json, text/plain, */*' \
-H 'content-type: application/json;charset=UTF-8' \
-H 'origin: https://store.forepaas.io' \
-H 'Authorization: Bearer <YOUR_AUTH_TOKEN>' \
--data-raw '{
"name":"My App",
"owner":"<ORGANIZATION_ID>",
"category":"My package",
"i18n":{
"fr":{
"name": "name fr",
"description": "desc fr",
"long_description": "long desc fr"
},
"en":{
"name": "name en",
"description": "desc en",
"long_description": "long desc en"
},
"jp":{
"name": "name jp",
"description": "desc jp",
"long_description": "long desc jp"
}
},
"image":"<base64 of image>",
"preview":[<base64 of image>, <base64 of image>, ...]
}' \
--compressed
レスポンス例
{
"status": 200,
"message": "Package updated with success",
"id": "<ORGANIZATION_ID>:my-app",
"package": {
"image": "",
"preview": [],
"name": "My App",
"i18n": {
"fr": {
"name": "name fr",
"description": "desc fr",
"long_description": "long desc fr"
},
"en": {
"name": "name en",
"description": "desc en",
"long_description": "long desc en"
},
"jp": {
"name": "name jp",
"description": "desc jp",
"long_description": "long desc jp"
}
},
"owner": "<ORGANIZATION_ID>",
"category": [
"My package"
],
"type": "modules",
"id": "<ORGANIZATION_ID>:my-package",
"versions": [],
"downloaded": 0
}
}
Warning
上記で取得したトークン値でYOUR_AUTH_TOKENを更新してください。
パッケージにバージョンを追加
パッケージのバージョンを.zipファイルで追加します
リクエスト例
curl 'https://store.forepaas.io/v1/packages/app/templates/<ORGANIZATION_ID>:my-app/<VERSION>' \
-X 'PUT' \
-H 'authority: store.forepaas.io' \
-H 'accept: application/json, text/plain, */*' \
-H 'content-type: application/zip' \
-H 'origin: https://store.forepaas.io' \
-H 'Authorization: Bearer <YOUR_AUTH_TOKEN>' \
--compressed --data-binary "@<PATH_TO_YOUR_FILE>"
レスポンス例
{
"success": true,
"status": 200,
"duration": 0.02
}
Warning
上記で取得したトークン値でYOUR_AUTH_TOKENを更新してください。
このエンドポイントを使用すると、特定のパッケージの現在の情報を確認できます。
curl 'https://store.forepaas.io/v1/packages/app/templates/<ORGANIZATION_ID>:my-app' \
-X 'GET' \
-H 'authority: store.forepaas.io' \
-H 'accept: application/json, text/plain, */*' \
-H 'origin: https://store.forepaas.io' \
-H 'Authorization: Bearer <YOUR_AUTH_TOKEN>'
パッケージバージョンの取得
このエンドポイントを使用すると、特定のパッケージバージョンをダウンロードできます。
curl 'https://store.forepaas.io/v1/packages/app/templates/<ORGANIZATION_ID>:my-app/<VERSION>' \
-X 'GET' \
-H 'authority: store.forepaas.io' \
-H 'origin: https://store.forepaas.io' \
-H 'Authorization: Bearer <YOUR_AUTH_TOKEN>' \
--output my-app_1.0.0.zip
すべてのストアAPIのリスト
アプリケーションテンプレート
アプリケーションテンプレートのAPIは次の通りです。
https://store.forepaas.io/v1/packages/app/templates/
APIテンプレート
APIテンプレートのAPIは次の通りです。
https://store.forepaas.io/v1/packages/api/templates/
ヒントとトラブルシューティング
- パッケージがGitリポジトリにホストされている場合は、パッケージを説明するJSONを専用のソースファイルとして保持してください。
<VERSION_ID>が1.0.0のような通常のバージョン番号であることを確認してください。
デフォルトで、ForePaaSストアはバージョン順に最新バージョンを提供します。- ZIPファイルにソースファイルのみを含み、中間コードやGitフォルダ（
.gitやnode_modulesなど）を含めていないことを確認してください。
- ZIPファイルがパッケージの期待に応えていることを確認してください。
例えば、アプリのテンプレートでは、ZIPアーカイブのルートにコンテンツがあるのではなく、ZIPファイル内にルートフォルダがあることが一般的なミスです。
良いZIPアーカイブ
.
|-- config
|-- forepaas
|-- public
|-- scripts
`-- src
悪いZIPアーカイブ
my-app
|-- config
|-- forepaas
|-- node_modules
|-- public
|-- scripts
`-- src
さらに詳しく
ソリューションを実装するためのトレーニングや技術サポートが必要な場合は、営業担当者にお問い合わせください、またはこのリンクをクリックして見積もりを依頼し、プロフェッショナルサービスの専門家にプロジェクトのカスタム分析を依頼してください。
Data Platformを構築しているチームと直接質問をし、フィードバックを共有し、交流するには、専用のDiscordチャネルにアクセスしてください。
OVHcloudサービスについてサポートが必要な場合は、ヘルプセンターでリクエストを作成してください。
ユーザーコミュニティに参加してください。
