メインコンテンツまでスキップ

Management APIとは

Management APIとは、管理者向けのアプリケーションインターフェースです。
Message APIの補助が想定利用ケースとして開発されています。
管理画面で作成したAPIキーを認証情報として、SmartPOSTに保存されている情報にアクセスできます。
近日、プレビューリリースされる予定です。

備考

想定利用ケースは2024/12現在のものとなります。
今後の要望等により、拡張される可能性があります。

備考

APIドキュメントについて、現在準備中です。

Management APIでできること

現在、Management APIでは情報取得(GET)のAPIのみの提供が予定されています。
書き込み、削除(PUT、POST、DELETE等)の機能は提供予定は未定です。

提供予定のAPIは次のとおりです。

  • プロジェクト
    • プロジェクト一覧の取得
    • プロジェクト詳細の取得
    • 受信者の取得
    • カスタム変数の取得
    • メッセージの画像URLの取得
  • 管理者
    • 管理者一覧の取得
    • 管理者詳細の取得
  • グループ
    • グループ一覧の取得
    • グループ詳細の取得
  • カスタムロール
    • カスタムロール一覧の取得
    • カスタムロール詳細の取得
  • カスタムポリシー
    • カスタムポリシー一覧の取得
    • カスタムポリシー詳細の取得
  • ヘルスチェック