SmartPOSTの公開APIドキュメントです。

API Docs

listAccountSubscriptions

GET

/v1/account-subscriptions

利用者が登録されているアカウントに関する情報を取得できます。

情報

xIDクライアントに登録されていないアカウントに関する情報は取得できません。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBearerの後にTokenを連結します

例：

Authorization: Bearer ********************

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

サンプル値:

Bearer <TOKEN>

Host

string

必須

UAT環境をご利用の場合はapi-uat.smartpost.jpを指定してください。

サンプル値:

User-Agent

string

必須

リクエスト元のアプリケーションやOS、ブラウザ、ユーザーエージェントのバージョンを識別するための文字列です。

サンプル値:

Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.smartpost.jp/v1/account-subscriptions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Host: api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion'

Response

🟢200Success

application/json

Body

smartpost_account_subscriptions

array [object {3}]

必須

登録されているアカウントに関する情報です。

account_id

string

必須

登録されているアカウントの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

smartpost_user_id

string

必須

登録されているアカウントに対する利用者の識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

subscriptions_status

boolean

必須

登録されているアカウントに対する利用者のステータスです。
デジタル郵便受けでの利用者の設定状況を取得できます。
true: 受け取り可
false: 受け取り不可

サンプル値:

true

例

{
    "smartpost_account_subscriptions": [
        {
            "account_id": "00000000-0000-0000-0000-acc000000001",
            "smartpost_user_id": "00000000-0000-0000-0000-acc000000002",
            "subscriptions_status": true
        },
        {
            "account_id": "00000000-0000-0000-0000-acc000000003",
            "smartpost_user_id": "00000000-0000-0000-0000-acc000000004",
            "subscriptions_status": false
        }
    ]
}

🟠401Unauthorized

🟠404Not Found

SmartPOST Message API 概要

healthcheck