アプリ利用企業一覧

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_app/company

リファレンス内容

アプリの利用企業一覧について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

本APIはアプリを利用可能な企業(※)のメイン機能企業ID(company_id)の一覧を返却します

※：無料期間中・契約中・解約予定の企業を利用可能な企業として返却します。解約が終了した企業は結果に返却しません

　　一度利用不可能になった企業が再契約した場合、再度利用可能な企業になります

入力パラメータ

パラメータ	値	省略	備考
`client_id`	ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントID	不可(SDKの場合不要)	テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する
`client_secret`	ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントシークレット	不可	client_idと同じ

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`count`	検索結果の件数
`data`	検索結果の連想配列(JSONのオブジェクト型) 例）“data”: [{ “company_id”: “xxxxxxxxx”, “company_ne_id”: “yyyyyyyy” }]	フィールドは企業のメイン機能企業ID（company_id）とネクストエンジン企業ID（company_ne_id）です。アプリ種別が「ログインのみアプリ」の場合は、メイン機能企業ID（company_id）がnullとなりますのでご注意ください。また、企業情報の取得は、各企業がアプリを起動した際に企業情報取得にて保持して下さい

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'client_id=xxxxxxxxx&client_secret=xxxxxxxxxxxxx' https://api.next-engine.org/api_app/company

レスポンス

{
  "result": "success",
  "count": "1",
  "data": [
    {
      "company_id": "xxxxxxxxxxxxxx"
    }
  ]
}

エラー

エラーコード

エンドポイント固有のエラーコードはありません。共通エラーコードはメッセージコード一覧を参照してください。