SmartStage 外部公開API利用マニュアル

このマニュアルでは、SmartStageの外部公開APIドキュメントの概要、APIパスの構成、およびAPIのテスト方法について解説します。アクションスクリプト等で外部連携を行う際にご活用ください。

目次

• 外部公開APIドキュメントについて
• APIパスの構成とURL指定
  •  一般公開URL
  • 高速レスポンス用URL
  • POSTメソッドの注意点（Payload）
• API動作の確認方法（Postmanの利用）

外部公開APIドキュメントについて

SmartStageの外部公開APIドキュメントは、以下のURLで公開されており、利用可能なAPIエンドポイント（GET/POSTなど）とその詳細（パラメータ、レスポンス形式）を確認できます。

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

スクリプト内でユーザー情報やアイテムの詳細情報が必要な場合、このドキュメントを参考に該当するAPIを選択し、HTTPリクエストを発行することでデータを取得・連携できます。

APIパスの構成とURL指定

APIを利用する際は、ドキュメントで確認したAPIパス（例: /items/{itemId}）の前に、適切なベースURLを付記して完全なリクエストURLを作成します。

一般公開URL

標準的なAPIアクセスに利用するURLです。

https://api.smart-stage.io/

高速レスポンス用URL

より速いレスポンスを求める場合、以下のURLを指定することで、ネットワークレイテンシ（応答時間）を削減できます。

http://api-internal.smart-stage.io/

注意: 内部URLを利用する際は、httpsではなくhttpプロトコルを指定してください。

POSTメソッドの注意点（Payload） 

データを新規作成したり、大きなデータを送信したりする際に使用するPOSTメソッドを実行する場合、リクエストには必ずPayload情報（リクエストボディ）が必要です。

POSTリクエストの必須項目
POSTメソッドを利用する際は、APIドキュメントで指定されている形式（通常はJSON形式）で、送信したいデータを格納したリクエストボディ (Payload)を付与する必要があります。

Payloadの内容（どのようなキーと値を設定すべきか）は、APIドキュメントの該当POSTエンドポイント（例: Request Bodyの項目）を参照して確認してください。

API動作の確認方法（Postmanの利用） 

スクリプトに組み込む前にAPIが意図通りに動作するかを確認するには、PostmanなどのAPIクライアントツールを利用するのが有効です。

Postmanを利用することで、実際のHTTPリクエストを送信し、APIからのレスポンス内容（JSONデータなど）を直接確認できます。これにより、スクリプト内で取得・利用すべきデータ構造を正確に把握することが可能になります。

Postman公式ウェブサイト: https://www.postman.com/

【確認手順の概要】

1. Postmanを起動し、新規リクエストを作成します。
2. APIドキュメントに基づき、メソッド（GET/POSTなど）と完全なリクエストURLを設定します。
3. 認証情報（必要な場合）を設定します。
4. POSTメソッドの場合、BodyタブでAPIドキュメントに沿ったPayload情報を設定します。
5. リクエストを送信し、返却されたステータスコードとJSONレスポンスの内容を確認します。

APIの仕様を正確に理解し、効率的にスクリプトを開発するために、Postmanでの事前確認を推奨します。

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