このページでは、AppPotが提供するAPIの一覧と、各APIで必要とする認証トークンと権限についてまとめています。

認証トークンには次の2つがあります。

  • 匿名トークン:匿名トークン取得APIで取得できるトークンです。
  • ユーザートークン:ユーザー認証APIで取得できるトークンです。

認証

認証APIの詳細

API名 Web API 必要とする認証トークン 必要な権限
匿名トークン取得 (GET) /anonymousTokens 不要 特になし
デバイス登録 (POST) /devices 匿名トークン 特になし
ユーザー認証 (POST) /auth/login 匿名トークン 特になし
ログアウト (POST) /auth/logout ユーザートークン 特になし

データベース作成

データベース作成APIの詳細

API名 Web API 必要とする認証トークン 必要な権限
DB作成 (POST) /schemas 匿名トークン 特になし
DBの存在確認 (GET) /schemas 匿名トークン 特になし
エンティティの作成 (POST) /CreateAppEntities 匿名トークン 特になし

グループとユーザーの管理

グループAPIの詳細
ユーザーAPIの詳細
ロールAPIの詳細

API名 Web API 必要とする認証トークン 必要な権限
グループの参照 (GET) /groups ユーザートークン 特になし
グループの作成 (POST) /groups ユーザートークン SuperAdmin, Admin
グループの更新 (PUT) /groups ユーザートークン SuperAdmin, Admin
グループの削除 (DELETE) /groups ユーザートークン SuperAdmin, Admin
ユーザーの参照 (GET) /users ユーザートークン 特になし
ユーザーの作成 (POST) /users ユーザートークン SuperAdmin, Admin
ユーザーの更新 (PUT) /users ユーザートークン SuperAdmin, Admin
ユーザーの削除 (DELETE) /users ユーザートークン SuperAdmin, Admin
ロールの参照 (GET) /roles ユーザートークン 特になし

データ管理

データ管理APIの詳細

API名 Web API 必要とする認証トークン 必要な権限
データの検索 (POST) /data/query ユーザートークン 特になし
データの登録 (POST) /data/batch/addData ユーザートークン 特になし
データの更新 (POST) /data/batch/updateData ユーザートークン 特になし
データの削除 (POST) /data/batch/deleteData ユーザートークン 特になし

ロギング

ロギングAPIの詳細

API名 Web API 必要とする認証トークン 必要な権限
ログレベルの取得 (GET) /logLevel 匿名トークン 特になし
ログメッセージの送信 (POST) /logs 匿名トークン 特になし

ファイル

ファイルAPIの詳細

API名 Web API 必要とする認証トークン 必要な権限
ファイルのURLを取得 (GET) /files ユーザートークン 特になし
ファイルの作成 (POST) /files ユーザートークン 特になし
ファイルの更新 (PUT) /files ユーザートークン 特になし
ファイルの削除 (DELETE) /files ユーザートークン 特になし

Push通知

Push APIの詳細

API名 Web API 必要とする認証トークン 必要な権限
Pushメッセージの送信 (POST) /messages ユーザートークン 特になし

他システム連携

Gateway APIの詳細

API名 Web API 必要とする認証トークン 必要な権限
他システムへのメッセージの転送 (GET/POST/PUT/DELETE) /gateway ユーザートークン 特になし

Eメール送信

Mail APIの詳細

API名 Web API 必要とする認証トークン 必要な権限
eメールの送信 (POST) /emails ユーザートークン 特になし