SmartStageのAPIについて

SmartStageのAPIの使用方法やAPIの一覧をご案内します。

目次

• API とは
• 事前準備
• API 使用環境
• API 使用方法について
• レスポンスコードについて
• API 一覧

API とは

APIとは、SmartStageの各種機能を他アプリケーションなどから使用することのできる専用のインターフェース（Application Programming Interface）です。

SmartStageに登録されている情報に外部システムからアクセスし、データの取得や登録、更新を自動化することが可能です。

事前準備

SmartStage APIを呼び出すためには、認証用トークンの発行が必須となります。

🔗 APIトークンの発行について

発行したトークンは、すべてのAPIリクエストのHTTPヘッダーに以下のように指定してください。

Authorization: ●●●●●●●●●●●●●●●(発行したトークン)

API 使用環境

環境	ベースURL
本番環境	https://api.smart-stage.io/

API 使用方法について

APIを使用する際は、「ベースURL ＋ 各APIのパス」を指定します。

例：アイテム情報を取得する場合（GET）
https://api.smart-stage.io/items/{itemid}

各APIで必要なパラメータや詳細仕様については、後述の「API一覧」よりリファレンスをご確認ください。

レスポンスコードについて

コード	意味	説明
200	OK	正常終了。
400	Bad Request	リクエスト不正（パラメータや構文エラー）。
401	Unauthorized	認証エラー（トークン不足、または無効）。
403	Forbidden	アクセス権限がありません。
404	Not Found	対象のリソース（アイテム等）が見つかりません。
500	Server Error	サーバー内部エラー。

API一覧

詳細なリファレンス（Swagger）はリンク先をご確認ください。

アイテム関連 API

API名	Method	概要
アイテム取得	GET	指定したアイテムの作成情報や項目値を取得します。
アイテム登録	POST	新規アイテムを登録します。 ※datastoreid, actionid ,bodyデータが必要です。
アイテム更新	POST	既存のアイテムを更新します。 ※itemid, actionid ,bodyデータが必要です。

SmartStage公開APIの仕様は以下のドキュメントをご確認ください。

https://api.smart-stage.io/swagger/index.html

何かお困りのことはございますか？まずはヘルプセンターを検索してみましょう！
その他ご不明な点があれば、サポートチームにお問い合わせください。