共通リファレンス (1.0.0)

Download OpenAPI specification:Download

API 共通仕様

外部システム連携 API の共通仕様を以下に示す。

API を利用する際の共通仕様は以下のとおりです。

Authorization
- 認可情報を設定する
- 認証時に取得したアクセストークンをBearerに付加し設定する
- 例：Bearer 1234a567-b890-1c23-4567-89d01e2f3a45
Content-type
- HTTP メソッドがPOST,PUTの場合、ボディ情報の形式を設定する
- JSON 形式の場合は「application/json」を設定する
- XML 形式の場合は「text/xml」を設定する
Accept
- レスポンスで受信する形式を設定する
- JSON 形式で受信する場合は「application/json」を設定する
- XML 形式で受信する場合は「text/xml」を設定する
- 指定する際はクエリ文字列やボディ情報の「レスポンス形式（response_type）」と合わせる必要がある
- クエリ文字列やボディ情報が不正だった場合（JSON のカンマや XML のタグの漏れなど）、又はクエリ文字列やボディ情報の「レスポンス形式（response_type）」が不正だった場合に適用される
accept-encoding
- メソッドを利用する際にレスポンスで受信するボディ情報を圧縮する際に設定

パラメータ	値
`response_type`	`json` or `xml`

パラメータは文字コードを「UTF-8」にし、適切に URL エンコードすること
HTTP メソッドがGETの場合
- URL にパラメータをクエリ文字列として付加しリクエストする
HTTP メソッドがPOST,PUTの場合
- ボディ情報にパラメータを設定しリクエストする
- パラメータは JSON 形式または XML 形式で設定する

ステータスコード	実行結果	例
`200(OK)`	成功
`400(Badrequest)`	リクエスト不正	JSON/XML の書式不正や JSON/XML に必要な要素が記述されていない
`401(Unauthorized)`	認証エラー	アクセストークンの不正や期限切れ
`403(Forbidden)`	権限無エラー	有料会員の資格無
`404(NotFound)`	リソース無	URL に誤りがある
`405(MethodNotAllowed)`	許可されていないメソッド	`POST`が許可されていない URI に対して`POST`メソッドを利用する
`415(UnsupportedMediaType)`	サポートしていないメディアタイプ	`Content-type`に`application/json`,`text/xml`以外を設定した
`500(InternalServerError)`	サーバー内部エラー	サーバーの内部的な問題で処理が完了しない発生時はシステム管理者にお問い合わせください
`503(Serviceunavailable)`	サービス利用不可	メンテナンス中のため要求を受け付けられない

ヘッダ名	値	備考
`authorization`	`Bearer` + アクセストークン	リクエストで指定した形式が設定
`Content-type`	`application/json; charset=UTF-8` or `text/xml; charset=UTF-8`	リクエストで指定した形式が設定
`accept`	`application/json; charset=UTF-8` or `text/xml; charset=UTF-8`	リクエストで指定した形式が設定
`accept-Encoding`	`gzip`	リクエストで指定した形式が設定

基本的にボディ情報の形式は以下の「レスポンス形式（response_type）」によって決定される
- GETの場合：リクエストのクエリ文字列
- POST,PUTの場合：ボディ情報
例外的に以下の場合はリクエストのヘッダ情報の「Accept」によって決定される（「Accept」が未設定の場合は JSON 形式）
- リクエストのクエリ文字列またはボディ情報が不正だった場合（JSON のカンマや XML のタグの漏れなど）
- リクエストのクエリ文字列またはボディ情報の「レスポンス形式（response_type）」が不正だった場合