AiMeet WEB API

Version 1.1.2 (2026-02-07)

非接触型展示会DXシステム「AiMeet」外部連携API仕様書 非接触式展会DX系统"AiMeet"外部对接API规范文档

🚀 APIテストツールを開く打开API测试工具 📊 データ分析ダッシュボード数据分析仪表板 📄 PDF仕様書PDF规范文档

概要概述

本APIは非接触型展示会DXシステム「AiMeet」の外部連携用APIです。全APIは共通レスポンスラッパー形式を採用します。 本API是非接触式展会DX系统"AiMeet"的外部对接API。所有API采用统一的响应封装格式。

ベースURL基础URL

本番環境生产环境
https://aibox.aimeet.jp/webapi
検証環境测试环境
https://aibox-test.aimeet.jp/webapi

共通レスポンス形式通用响应格式

{
  "status": 0,           // 0:成功成功 / 1000以降:エラー以上:错误
  "errmsg": "success",   // エラーメッセージ错误消息
  "data": [...],         // 実行結果配列执行结果数组
  "timeStamp": 1740577332 // UNIX時刻时间戳
}

認証 (Auth)认证 (Auth)

GET /auth/getAccessToken

アクセストークンを取得します。トークンは2時間で失効します。 获取访问令牌。令牌2小时后过期。

⚠️ 重要:重要: 他のAPI呼び出し前に必ずトークンを取得してください。 调用其他API前必须先获取令牌。

リクエストパラメータ请求参数

パラメータ参数 类型 必須必需 説明说明
user string 必須必需 ユーザー名用户名
password string 必須必需 パスワード密码

レスポンス例响应示例

{
  "status": 0,
  "errmsg": "success",
  "data": [
    { "accessToken": "abc123xyz..." }
  ],
  "timeStamp": 1740577332
}

実装例实现示例

// JavaScript fetch示例
const response = await fetch(
  'https://aibox.aimeet.jp/webapi/auth/getAccessToken?' +
  new URLSearchParams({ user: 'your_user', password: 'your_pass' })
);
const result = await response.json();
const token = result.data[0].accessToken;

出展社 (Admin)参展商 (Admin)

GET /admin/getAdminInfo

出展社情報を取得します。 获取参展商信息。

リクエストパラメータ请求参数

パラメータ参数 类型 必須必需 説明说明
accessToken string 必須必需 認証トークン认证令牌
id integer 任意可选 出展社ID参展商ID
username String(64) 任意可选 ユーザー名用户名
exhibitionID integer 必須必需 展示会ID展会ID
📋 パラメータ組み合わせ:参数组合:
① id + exhibitionID + accessToken:展示会IDの指定IDでアカウント情報を取得
② username + exhibitionID + accessToken:展示会IDで指定アカウント名でアカウント情報を取得
① id + exhibitionID + accessToken:通过展会ID和指定ID获取账户信息
② username + exhibitionID + accessToken:通过展会ID和指定账户名获取账户信息

レスポンスデータ (Admin)响应数据 (Admin)

フィールド字段 类型 説明说明
id integer 出展社ID参展商ID
username string ユーザー名用户名
nickname string ニックネーム昵称
email string メールアドレス电子邮箱
exhibitionID integer 展示会ID展会ID
loginTime int64 最終ログイン時刻(UNIX)最后登录时间(UNIX)
boothNo string ブース番号展位编号
viscannerNumber integer Viscannerデバイス数Viscanner设备数
smartNumber integer スマートデバイス数智能设备数
isExhibitor integer 出展社フラグ (1: YES / 0: NO)参展商标志 (1: YES / 0: NO)
productNumber integer 登録製品数注册产品数量

リクエスト例请求示例

GET /admin/getAdminInfo?accessToken=abc123xyz&id=101&exhibitionID=50

レスポンス例响应示例

{
  "status": 0,
  "errmsg": "success",
  "data": [
    {
      "id": 101,
      "username": "exhibitor_a",
      "nickname": "株式会社サンプル",
      "email": "contact@sample.co.jp",
      "exhibitionID": 50,
      "loginTime": 1740577000,
      "boothNo": "A-12",
      "viscannerNumber": 3,
      "smartNumber": 5,
      "isExhibitor": 1,
      "productNumber": 2
    }
  ],
  "timeStamp": 1740577332
}

展示会 (Exhibition)展会 (Exhibition)

GET /exhibition/getExhibitionInfo

展示会情報を取得します。 获取展会信息。

リクエストパラメータ请求参数

パラメータ参数 类型 必須必需 説明说明
accessToken string 必須必需 認証トークン认证令牌
id integer 任意可选 展示会ID展会ID

レスポンスデータ (Exhibition)响应数据 (Exhibition)

フィールド字段 类型 説明说明
id integer 展示会ID展会ID
exhibitionName string 展示会名展会名称
exhibitionAdminID integer 主催者ID主办方ID
startTime integer 開始時刻(UNIX)开始时间(UNIX)
endTime integer 終了時刻(UNIX)结束时间(UNIX)
loginStartTime integer ログイン開始時刻登录开始时间
loginEndTime integer ログイン終了時刻登录结束时间
exhibitorNumber integer 出展社数参展商数量
isExternalAPI integer 外部API有効(0/1)外部API启用(0/1)

製品 (Product)产品 (Product)

GET /product/getProductInfo

製品情報を取得します。 获取产品信息。

リクエストパラメータ请求参数

パラメータ参数 类型 必須必需 説明说明
accessToken string 必須必需 認証トークン认证令牌
id integer 任意可选 製品ID产品ID
exhibitionID integer 任意可选 展示会ID展会ID
exhibitorID integer 任意可选 出展社ID参展商ID

レスポンスデータ (Product)响应数据 (Product)

フィールド字段 类型 説明说明
id integer 製品ID产品ID
productAdminID integer 製品管理者ID产品管理员ID
boothName string ブース名展位名称
exhibitionID integer 展示会ID展会ID
cateName string カテゴリ名分类名称
productName string 製品名产品名称

来場者・履歴 (Visitor)访客・记录 (Visitor)

GET /visitor/getReaderRecord

閲覧履歴を取得します。 获取浏览记录。

リクエストパラメータ请求参数

パラメータ参数 类型 必須必需 説明说明
accessToken string 必須必需 認証トークン认证令牌
aiTagID string 任意可选 AiTag ID
productID integer 任意可选 製品ID产品ID
exhibitionID integer 任意可选 展示会ID展会ID
startTime integer 任意可选 開始時刻(UNIX)开始时间(UNIX)
endTime integer 任意可选 終了時刻(UNIX)结束时间(UNIX)
GET /visitor/getEntryRecord

入場記録を取得します。 获取入场记录。

リクエストパラメータ请求参数

パラメータ参数 类型 必須必需 説明说明
accessToken string 必須必需 認証トークン认证令牌
aiTagID string 任意可选 AiTag ID
exhibitionID integer 任意可选 展示会ID展会ID
startTime integer 任意可选 開始時刻(UNIX)开始时间(UNIX)
endTime integer 任意可选 終了時刻(UNIX)结束时间(UNIX)

データスキーマ一覧数据结构一览

ApiResponse (共通レスポンス通用响应)

フィールド字段 类型 説明说明
status integer 実行結果コード (0=成功)执行结果代码 (0=成功)
errmsg string エラーメッセージ错误消息
data array 実行結果データ执行结果数据
timeStamp int64 レスポンス生成時刻响应生成时间

AccessToken

フィールド字段 类型 説明说明
accessToken string (max 60) アクセストークン访问令牌

デジタルギフト (Gift)数字礼品 (Gift)

検討中开发中 今後追加予定のAPI计划添加的API

デジタルギフト機能のAPIは現在検討中です。以下の機能が追加される予定です。 数字礼品功能的API目前正在开发中。计划添加以下功能。

予定されているエンドポイント计划的端点

メソッド方法 エンドポイント端点 説明说明 状態状态
GET /gift/getGiftInfo ギフト情報取得获取礼品信息 検討中开发中
GET /gift/getGiftList ギフト一覧取得获取礼品列表 検討中开发中
POST /gift/sendGift ギフト送信发送礼品 検討中开发中
GET /gift/getGiftHistory ギフト履歴取得获取礼品历史记录 検討中开发中
📋 注意:注意: このセクションのAPIは開発中のため、仕様が変更される可能性があります。正式リリース時に詳細な仕様が公開されます。 此部分的API正在开发中,规范可能会更改。正式发布时将公布详细规范。

エラーコード错误代码

APIレスポンスの status フィールドで返されるエラーコード一覧です。 API响应中 status 字段返回的错误代码列表。

コード代码 エラー名错误名 説明说明 対処方法处理方法
0 成功成功 APIリクエストが正常に処理されましたAPI请求已成功处理 -
1000 認証失敗认证失败 ユーザー名またはパスワードが正しくありません用户名或密码不正确 認証情報を確認してください请确认认证信息
1001 リクエストパラメータエラー请求参数错误 必須パラメータが不足、または形式が不正です必需参数缺失或格式不正确 APIドキュメントを確認し、パラメータを修正してください请查阅API文档并修正参数
1002 accessToken未指定未指定accessToken accessTokenパラメータが存在しませんaccessToken参数不存在 リクエストにaccessTokenを追加してください请在请求中添加accessToken
1003 accessToken無効accessToken无效 accessTokenがタイムアウト(2時間)または不正ですaccessToken已超时(2小时)或无效 /auth/getAccessToken で新しいトークンを取得してください请通过/auth/getAccessToken获取新令牌
1004 コマンド送信エラー命令发送错误 サーバー内部でコマンド送信に失敗しました服务器内部命令发送失败 しばらく待ってから再試行してください请稍后重试
1005 データなし无数据 指定した条件に一致するデータが存在しません没有符合指定条件的数据 検索条件を確認してください请确认搜索条件
1006 アクセス権限なし无访问权限 該当リソースへのアクセス権限がありません没有访问该资源的权限 権限のあるアカウントで認証してください请使用有权限的账户进行认证
💡 ヒント:提示: エラー発生時は status が1000以上となり、errmsg に詳細が格納されます。 发生错误时 status 会大于等于1000,errmsg 中包含详细信息。

エラーレスポンス例错误响应示例

{
  "status": 1003,
  "errmsg": "accessToken timeout or invalid",
  "data": [],
  "timeStamp": 1740577332
}

エラーハンドリング実装例错误处理实现示例

// JavaScript エラーハンドリング例错误处理示例
async function callApi(endpoint, params) {
  const response = await fetch(endpoint + '?' + new URLSearchParams(params));
  const result = await response.json();
  
  if (result.status === 0) {
    return result.data;
  }
  
  switch (result.status) {
    case 1003:
      // トークン期限切れ - 再取得して再試行令牌过期 - 重新获取并重试
      const newToken = await refreshToken();
      params.accessToken = newToken;
      return callApi(endpoint, params);
    case 1005:
      // データなし - 空配列として処理无数据 - 作为空数组处理
      return [];
    default:
      throw new Error(`API Error ${result.status}: ${result.errmsg}`);
  }
}

HTTPステータスコードHTTP状态代码

本APIでは、HTTPステータスコードとAPIエラーコードの両方を使用してエラーを通知します。 本API同时使用HTTP状态代码和API错误代码来通知错误。

HTTP Status 説明说明 対応するAPIエラーコード对应的API错误代码
200 OK リクエスト成功请求成功 0 (成功成功)
400 Bad Request リクエストパラメータエラー请求参数错误 1001
401 Unauthorized 認証エラー认证错误 1000, 1002, 1003
403 Forbidden アクセス権限なし无访问权限 1006
404 Not Found データなし无数据 1005
500 Internal Server Error サーバー内部エラー服务器内部错误 1004
💡 注意:注意: HTTPステータスコードが 200 でも、レスポンスボディの status0 以外の場合はエラーです。両方を確認してください。 即使HTTP状态代码为 200,如果响应体中的 status 不是 0,也表示错误。请同时确认两者。