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

API Docs

listCustomPolicies

GET

/v1/custom-policies

このエンドポイントを使用することで、カスタムポリシーの一覧を取得できます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBasicの後にスペースと、Base64でエンコードされたusername:passwordが連結されます

例：

Authorization: Basic *****************

Queryパラメータ

keyword

string

可選

カスタムポリシー名に対する検索キーワードを指定できます。

サンプル値:

sample policy

page

integer

可選

ページ番号を指定できます。

サンプル値:

page_size

integer

可選

1ページに含まれるレコードの数を指定します。0-100を指定可能、指定しない場合は100となります。

サンプル値:

100

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

Basic認証を利用します。値にはBasicの後にスペースとBase64でエンコードされた{API key ID}:{API key secret}を利用します。

サンプル値:

Basic QVBJa2V5SUQ6QVBJa2V5c2VjcmV0

Host

string

必須

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

サンプル値:

User-Agent

string

必須

サンプル値:

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://management-api.smartpost.jp/v1/custom-policies?keyword=sample policy&page=1&page_size=100' \
--header 'Accept: application/json' \
--header 'Host: management-api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion' \
--header 'Authorization: Basic Og=='

Response

🟢200Success

application/json

Body

pagination

object (Pagination_update)

必須

レスポンスのページネーションに関する情報です。

page

integer

必須

レスポンスのページ番号です。

サンプル値:

page_size

integer

必須

1ページに含まれるレコード数です。

サンプル値:

total_records

integer

必須

全レコード数です。

サンプル値:

filter

object (Filter_update)

可選

keyword

string

可選

フィルター条件に利用された値です。

サンプル値:

sample keyword

data

array [object {6}]

可選

カスタムポリシーの情報です。

string

必須

カスタムポリシーの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

account_id

string

必須

カスタムポリシーが属するアカウントの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

name

string

必須

カスタムポリシー名です。

<= 255 文字列

サンプル値:

sample custom policy name

description

string

可選

カスタムポリシーの説明です。

サンプル値:

sample description

created_by

string

必須

カスタムポリシーを作成した管理者のIDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

created_at

integer

必須

カスタムポリシーが作成された時刻（UNIX時間）です。

サンプル値:

1667899934

例

{
    "pagination": {
        "page": 1,
        "page_size": 20,
        "total_records": 32
    },
    "filter": {
        "keyword": "sample keyword"
    },
    "data": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "account_id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample custom policy name",
            "description": "sample description",
            "created_by": "00000000-0000-0000-0000-acc000000001",
            "created_at": 1667899934
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

getAdmin

getCustomPolicy