SmartPOST Management API 概要

SmartPOST Management APIへようこそ🙌

情報

SmartPOST Management APIはプレビューリリースのステータスです。

SmartPOSTとは

「SmartPOST（スマートポスト）」は、デジタルID「xIDアプリ」と連携した、自治体向けの郵送DXサービスです。

自治体職員は、LGWAN-ASP(自治体専用回線)サービスとして提供されるSmartPOST管理画面から、マイナンバーカードと連携した住民のxIDアプリに対して、メッセージの一括送信・個別送信ができます。

xIDアプリユーザーは、次の方法で受信したSmartPOSTメッセージを確認することができます。

xIDアプリの「デジタル郵便受け」機能

デジタル郵便受け for Web (https://mail.smartpost.jp)

SmartPOST Message APIを使用してメッセージを取得しているクライアントサービス

APIの概要

警告

Management APIはプレビューリリースのステータスです。
仕様について、予告なしに変更される場合があります。ご了承ください。

SmartPOST Management APIは、SmartPOSTに対して管理者としての操作を行うことができるAPIです。
利用者としての操作については、Message APIを利用することを推奨します。
現在は読み取りのリクエストのみをサポートしており、次の操作を実施できます。

プロジェクト関連

プロジェクト一覧の取得（listProjects）

プロジェクト詳細の取得（getProject）

メッセージ内に挿入された画像の署名付きURLの取得（getImageUrls）

プロジェクトに設定された受信者情報の取得（listProjectRecipients）

プロジェクトに設定されたカスタム変数情報の取得（listProjectVars）

管理者関連

管理者一覧の取得（listAdmins）

管理者詳細の取得（getAdmin）

カスタムポリシー関連

カスタムポリシー一覧の取得（listCustomPolicies）

カスタムポリシー詳細の取得（getCustomPolicy）

カスタムロール関連

カスタムロール一覧の取得（listCustomRoles）

カスタムロール詳細の取得（getCustomRole）

グループ関連

グループ一覧の取得（listGroups）

グループ詳細の取得（getGroup）

各エンドポイントの仕様については、API仕様をご確認ください。

利用開始方法

SmartPOSTを既にご利用の場合は、Management APIの認証に必要なAPIキーをSmartPOST管理画面にて用意いただき、利用開始することができます。
ユーザーガイド: APIキーの管理

SmartPOSTをまだご利用でない場合は、弊社コーポレートサイトお問い合わせフォームよりお問い合わせください。

APIの認証について

Basic認証を利用します。
リクエストのヘッダーにAuthorizationヘッダーを付与します。
値にはBasicの後にスペースを入れ、APIキーID:APIキーシークレットをBase64エンコードした文字列を入力します。

サンプル:

Basic ZDE5OGJhMzktODMwYS00M2E4LTgxNjQtZDFmNGU5NzM4ZjRmOnNwLUdyV0tmVWU0aTVDNEFMaEF3S0o2dXJ1dFRvWGc4

情報

上記のサンプルは次のサンプル値から生成したものです。
APIキーID: d198ba39-830a-43a8-8164-d1f4e9738f4f
APIキーシークレット: sp-GrWKfUe4i5C4ALhAwKJ6urutToXg8

情報

APIドキュメント公開しているツールの仕様上、Authorization headerに関してUsername、Passwordと表記される場合がありますが、それぞれAPIキーID、APIキーシークレットと読み替えてください。

APIのレスポンスの基本仕様

特に記載のない場合、可変（オプショナル）の項目については、値がない、また、空の場合、項目自体が表示されません。
配列（Array）、オブジェクトの項目については、空の配列、オブジェクトが返される場合があります。

レートリミット

1分間に120リクエストまで

レートリミットは接続元のIPアドレス単位で適用されます。
レートリミットが適用された場合、リクエストは一時的に制限され、ステータスコード 429 を返します。

情報

レートリミットの実装の仕様上、制限が完全に一致することは保証しておりません。
余裕を持った、かつ、レート超過した際のエラーハンドリングの実装等、フールプルーフ設計を推奨しています。

稼働時間

本番環境：常時稼働

UAT環境：平日 9:00 ~ 19:00

SmartPOST Management API 概要

SmartPOSTとは#

APIの概要#

利用開始方法#

APIの認証について#

APIのレスポンスの基本仕様#

レートリミット#

稼働時間#

SmartPOSTとは

APIの概要

利用開始方法

APIの認証について

APIのレスポンスの基本仕様

レートリミット

稼働時間