WebAPI

概要

各リソースに対するWEBインターフェースをWebAPIとして用意しています。WebAPIを利用することで、自動連携等のリアルタイムかつフレキシブルな連携が可能です。

エンドポイント

WebAPIのエンドポイントはご利用環境のSmartDBとなります。ベースURLを基準とし、操作対象リソースをURLに付加することで操作対象リソースのエンドポイントとなります。

表中の{ホスト名}記載については、ご利用環境のSmartDBのFQDNのホスト名に読替えてご確認ください。

プロトコル

HTTPS

ベースURL

https://{ホスト名}.smartdb.jp/api/v1
リソース エンドポイント

アカウントマスタ連携

https://{ホスト名}.smartdb.jp/api/v1/accountMasters

認証

WebAPIを利用するためにはリクエスト毎に認証が必要です。WebAPIへのリクエストにシステムトークンを付加することにより認証することが可能です。

システムトークンの詳細についてはこちらをご確認ください。

認証ヘッダー

WebAPIへのリクエストにシステムトークンを付加するためには、HTTPヘッダーに認証ヘッダーとしてAuthorizationヘッダーを付加する必要があります。

HTTPヘッダ名 値

Authorization

Bearer␣{システムトークン}
Bearerとシステムトークンは半角スペースで区切る必要があります。
例
# curl -H "Authorization: Bearer XXXXXXXXXXX" https://xxxx.smartdb.jp/api/v1/accountMasters

権限

管理画面で取得したシステムトークンを利用することで、SmartDB管理者としてAPIが実行されます。SmartDB管理者はWebAPIにおいて、すべての操作が可能な特権ユーザとなります。

リクエスト(レスポンス)

データ形式

アカウント連携APIはデータの送受信にJSON形式の文字列を利用しています。データを送信する場合、Content-Typeヘッダにapplication/jsonを指定してださい。

ヘッダ名 値

Content-type

application/json

 
# curl -X POST -H "Authorization: Bearer XXXXXXXXXXX" -H "Content-type: application/json" https://xxxx.smartdb.jp/api/v1/accountMasters/lock

文字コード

URLに指定するクエリ及びリクエストボディに使用する文字コードはUTF-8となります。APIにより文字コードを指定できる場合は、APIに準じます。

エラー

レスポンスヘッダのステータスコードに20x以外が返却された場合、エラーとなります。エラー内容の詳細はレスポンスボディとして返却されます。

レスポンスボディ定義
key データ型 必須 内容

statusCode

number

○

HTTPステータスコード

message

string

○

エラーメッセージ

errCode

string

○

エラーコード

errDetail

array

エラー詳細 [1]

1. 原則ステータスコードが400(validationエラー)の場合に返却されます。
レスポンス例
{
  "statusCode": 400,
  "message": "Bad Request",
  "errCode": "USER-PASS-EXIST-IN-HISTORY",
  "errDetail": [
    {
      "errCode": "VALIDATOR-PARAMS-INVALID-TYPE",
      "key": "string"
    }
  ]
}