API Docs
Message APIManagement API
Message APIManagement API
xID for Developers
SmartPOST 管理画面
  1. Management API
  • SmartPOST Management API 概要
  • 用語定義
  • project
    • listProjects
      GET
    • getProject
      GET
    • listImageUrls
      GET
    • listProjectRecipients
      GET
    • listProjectVariables
      GET
  • admin
    • listAdmins
      GET
    • getAdmin
      GET
  • custom policy
    • listCustomPolicies
      GET
    • getCustomPolicy
      GET
  • custom role
    • listCustomRoles
      GET
    • getCustomRole
      GET
  • group
    • listGroups
      GET
    • getGroup
      GET
  • health
    • healthCheck
      GET
  1. Management API

用語定義

全般#

用語用語（English）説明
管理画面Admin consoleWebブラウザで利用するSmartPOSTの管理用画面を指します。利用者に対する通知を作成したり、SmartPOST管理画面における権限管理等を行うことができます。
アカウントAccount利用者への通知を管理する組織単位のことを指します。SmartPOSTに管理者としてログインして各設定等を管理する単位と同意です。利用者がアカウントに対してサブスクライブすることで管理者は利用者に対し、通知を送信できるようになります。
利用者User「デジタル郵便受け」の利用者を指します。
SmartPOST利用者IDSmartPOST user IDアカウント毎に一意の利用者に対する識別子です。同一人物が複数のアカウントにサブスクライブしている場合、アカウント毎に異なる識別子を持ちます。
無効フラグDisable flag利用者がお亡くなりになったなど本人が利用者登録停止を出来ない場合に、管理者がステータスを無効にすることにより、通知対象から除外することができます。

プロジェクト#

用語用語（English）説明
プロジェクトProjectSmartPOSTによって利用者に通知を送信する際の一つのまとまりを”プロジェクト”としています。プロジェクトの中で通知のタイトル、文面、通知日時、プロジェクトに対する権限等、様々な設定をすることができます。
作成者Author対象のプロジェクトを作成した管理者を指します。
受信者Recipient通知の宛先として利用者を設定すると受信者として登録されます。受信者には同一の利用者においても各プロジェクトに対し、一意な識別子（ID）が割り当てられます。
承認者Approverプロジェクトの承認を行う管理者です。プロジェクトを通知するには、承認者が設定され、設定されたすべての承認者が承認する必要があります。
グループ権限Group permission管理者が所属しているグループによってプロジェクトの可視、操作可否を管理する設定を指します。プロジェクトに対し、許可するグループを指定します。グループ権限を設定した場合、プロジェクトの作成者を除き、許可されたグループに所属していない管理者はプロジェクトにアクセスすることができません。
WelcomeプロジェクトWelcome projectxIDユーザーがSmartPOSTにオプトインした際にメッセージを届ける機能、および、その設定を行うプロジェクトのこととする
カスタム変数Custom variablesメッセージにカスタム変数を設定することにより、受信者が受信した際に受信者によって異なる値をメッセージに含めることができます。カスタム変数にはメッセージにおける取り扱いに応じて「通常変数」、「QRコード変数」、「バーコード変数」の種別があります。
通常変数Normal variablesメッセージに文字列（URL、メールアドレス含む）として表示する変数を指します。
QRコード変数QRcode variablesメッセージにQRコードとして表示する変数を指します。
バーコード変数Barcode variablesメッセージにバーコードとして表示する変数を指します。現時点においてはNW-7のみ対応しています。
テンプレートTemplateプロジェクトを作成する際に参照できるテンプレートを指します。あらかじめ必要な項目（受信者、メッセージ、承認者等）をテンプレートとして保存できます。データの実体としてはtypeの異なるプロジェクトとして取り扱われ、listProjects、getProjectといったAPIで取り扱います。
メッセージカテゴリーMessage Categoryメッセージ、プロジェクト、テンプレートを分類するためのカテゴリーを指します。一つのリソースに対して、複数のメッセージカテゴリーを付与することができます。利用者にとって、どのようなものか、という観点で表現されます。
個別PDFファイルIndividual PDFメッセージに添付されるPDFファイルのうち、受信者ごとに異なる値を持ったPDFファイルです。プロジェクトに設定された基礎となるPDFファイルに変数を配置することにより、受信者ごとに異なるファイルになるように設計されています。電子署名をすることが可能であり、1つのプロジェクトに対し、1つのみ添付することが可能です。
共通PDFファイルCommon PDFメッセージに添付されるPDFファイルのうち、全ての受信者に共通のPDFファイルです。

管理者#

用語用語（English）説明
管理者AdminSmartPOST 管理画面にログインするユーザーを指します。

カスタムポリシー#

用語用語（English）説明
カスタムポリシーCustom Policy管理者が任意で設定可能なSmartPOST管理画面の権限設定を指します。「カスタムロール」「グループ」「APIキー」に付与することができます。

カスタムロール#

用語用語（English）説明
カスタムロールCustom Role管理者が任意で設定できる管理者のロール（役割）を指します。あらかじめ用意されている「オーナー」「承認者」「メンバー」と同列のもので、管理者に対して設定して利用します。

グループ#

用語用語（English）説明
グループGroup管理者のグループ分けをすることができ、その単位を指します。グループは任意の権限を付与して許可設定を行ったり、プロジェクトのグループ権限で指定しプロジェクトに対する権限を設定したりできます。
更新日時 2025-12-19 06:35:21
前へ
SmartPOST Management API 概要
次へ
listProjects
Built with