スマレジDevelopers API仕様書 (ver 1.0.0) (1.0.0)

概要

エンドポイント

https://api.developers.smaregi.dev/v1

認証

Authorizationヘッダーに下記を設定します。

Basic {Base64文字列}
Base64文字列には、クライアントIDとクライアントシークレットをコロン(:)で結合してBase64エンコードしたものを指定。

※Developers APIはアプリ単位ではなく、契約ID単位での利用となります。
クライアント情報はデベロッパーズ内の設定 > Developers API から作成してください。

ページネーション

一度に返すアイテム数は limitパラメータで指定でき、上限は1000件です。
取得する対象ページは page で指定できます( 1 始まり)。
並び順はsortパラメータで指定可能です。

QUERY PARAMETER	型	値の範囲	初期値
page	integer	1 〜	1
limit	integer	1 〜 1000	100
sort	string	`パラメータ名指定` `並び替え順指定`「パラメータ名:desc」での指定が可能	（各APIで主キーとなるID）:asc

リクエスト例）利用者一覧、10件ずつ表示の1ページ目、並び順がcontractIdの降順の場合

https://api.developers.smaregi.dev/v1/apps/{アプリキー}/users?limit=10&page=1&sort=contractId:desc

利用者一覧

利用者一覧の取得

Authorizations:

BasicAuth

path Parameters

app_key

required

string <uuid> = 36 characters

アプリキー UUID 基本情報画面のアプリキー項目に記載されています。

query Parameters

page	integer >= 1 Default: 1 検索対象ページ
limit	integer [ 1 .. 1000 ] Default: 100 上限値
sort	string Default: "contractId" ソート順（パラメータ名指定パラメータ名:descで降順指定可）指定可能なパラメータ名: `contractId`, `companyName`, `mailAddress`, `trialStartDate`, `contractDate`

Responses

Response samples

Content type

application/json

[{"contractId": "sample1_contract_id",
"companyName": "SampleCompany1",
"mailAddress": "sample@example.com",
"isProvidedMailAddress": true,
"trialStartDate": "2022-05-01",
"contractDate": "2022-05-01",
"planName": "standard",
"monthlyPrice": 10000,
"quantity": 3,
"options": [{"price": 3000,
"unitPrice": 1000,
"quantity": 3,
"name": "電話サポート"
},
{"price": 100,
"unitPrice": 100,
"quantity": 1,
"name": "チャットサポート"
}
]
},
{"contractId": "sample2_contract_id",
"companyName": "SampleCompany2",
"mailAddress": "********************",
"isProvidedMailAddress": false,
"trialStartDate": "2022-05-01",
"contractDate": "2022-05-01",
"planName": "standard",
"monthlyPrice": 0,
"quantity": 1,
"options": [{"price": 1000,
"unitPrice": 1000,
"quantity": 1,
"name": "電話サポート"
}
]
}
]