アプリ利用企業一覧

POST

/api_app/company

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

// POST /api_app/company - アプリ利用企業一覧
const params = new URLSearchParams({
  access_token: '<access_token>',
  // client_id: '...', // optional
})
const res = await fetch('https://api.next-engine.org/api_app/company', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_app/company - アプリ利用企業一覧
import requests

params = {
    'access_token': '<access_token>',
    # 'client_id': '...',  # optional
}
res = requests.post(
    'https://api.next-engine.org/api_app/company',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

client_id

ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントID / テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する

string

client_secret

ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントシークレット / client_idと同じ

string

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

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

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}

アプリ利用企業一覧

Request Body required

Responses

200

Example

4XX

Example

Request Body^required