メインコンテンツへスキップ
サインイン

SmartStageのAPIについて

石井洋征
  • 更新


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

目次

 

 

API とは

APIとは、SmartStageの各種機能を他アプリケーションなどから使用することのできる専用のApplication Programming Interfaceです。
SmartStageに登録している情報にアクセスし、その情報を他アプリケーションでも活用することが可能です。

 

 


事前準備

SmartStage APIを呼び出すために、認証用トークンの発行が必要となります。
トークンの発行については、以下の記事を参照してください。

上記で発行したトークンは、リクエストのAuthorizationヘッダーに下記のように指定します。

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

※上記のトークンはどのAPIを呼び出す時にも必須になります。

 

 


API 使用環境

APIを使用できる環境は以下です。

環境 ベースURL

本番環境

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

 

 


API 使用方法について

SmartStageのAPIを使用する際には、「ベースURL＋APIのパス」を指定します。
例えば、プロセスやライブラリからアイテム情報の取得を行う時には下記のように指定し、APIを使用します。

https://api.smart-stage.io/items/{itemid}(GET)

上記リクエストを送信する際に、API毎に必要なリクエストパラメータが異なります。
APIの詳細情報については、後述のAPI一覧のリファレンスをご確認ください。

 

 


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

APIのレスポンスコードの意味は下記です。

コード 意味 説明
200 OK リクエストが正常終了していることを意味します。

400

 Bad Request リクエストが不正であることを意味します。
パラメータが不正であったり、構文エラーがある可能性があります。
401 Unauthorized 認証が必要であることを意味します。
詳細はレスポンスのエラー内容をご確認ください。
403 Forbidden アクセスが禁止されていることを意味します。
404 Not Found リクエストされた内容に対して、サーバー側で対象のリソースが発見できなかったことを意味します。
500 Internal Server Error サーバー側でエラーが発生していることを意味します。

 

 

API一覧

アイテム関連

API名

 Method 説明
アイテム取得 GET

SmartStageのアイテム情報を取得します。
下記の情報を返却します。詳細はリンクのリファレンスをご確認ください。

  • 作成日
  • 作成者
  • 画面項目毎の値
  • ステータスID
  • タイトル
  • 更新日
  • 更新者
アイテム登録 POST

SmartStageにアイテムを1件登録します。
本APIを呼び出すために必要なパラメータは下記で取得することが可能です。

  • datastoreid
    • 管理者メニュー＞プロセス設定＞基本設定
  • actionid
    • 管理者メニュー＞プロセス設定＞アクション設定
    • 管理者メニュー＞プロセス設定＞データ操作設定
  • createItemRequest＞fields＞fieldid
    • 管理者メニュー＞プロセス/ライブラリ設定＞項目設定

*1 リクエストパラメータのnameを「true」に指定した場合、
createItemRequest内のfieldidを項目名で指定することが可能です。

*2 createItemRequest内のfieldsの必須項目については値の指定が必要です。必須項目の設定については、「アクション実行時に表示する項目を変更する」を参照してください。
アイテム更新 POST SmartStageのアイテムを1件更新します。
本APIを呼び出すために必要なパラメータは下記で取得することが可能です。
  • actionid
    • 管理者メニュー＞プロセス設定＞アクション設定
    • 管理者メニュー＞プロセス設定＞データ操作設定
  • updateItemRequest＞fields＞fieldid
    • 管理者メニュー＞プロセス/ライブラリ設定＞項目設定

*1 リクエストパラメータのnameを「true」に指定した場合、
updateItemRequest内のfieldidを項目名で指定することが可能です。
*2 createItemRequest内のfieldsの必須項目については値の指定が必要です。必須項目の設定については、「アクション実行時に表示する項目を変更する」を参照してください。
*3 createItemRequest内のdatastoreidの指定は必須です。

 

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

関連記事

コメント

0件のコメント

サインインしてコメントを残してください。