＜JSONの記述についてはサポート対象外となりますので、貴社システム開発担当者様にて実装ください＞
URL
URLは下記の形式で記述します。
http://{サーバー名}/api/{コントローラー名}/{ID}/{メソッド名}
例）https://ks01.shelterdb.net/api/items/999/get
HTTPメソッド
ShelterのAPIはHTTPメソッドにPOSTを使用します。
以下のようなエラーが表示される場合は、HTTPメソッドが異なる可能性があります。
403 Forbidden "Message": "要求されたリソースは、http メソッド 'GET' をサポートしていません。"※エラーメッセージはサーバにより異なります。
リクエスト
ShelterのAPIはJSON形式での記述となります。
構文が誤っている場合、正しいリクエストとして認識されず以下のようなエラーが表示されます。
{"Id":0,"StatusCode":401,"Message":"認証できませんでした。"}上記のエラーが発生する場合、
・JSON構文が正しくない
・APIキーが正しくない
どちらかの可能性が高いので確認してください。
JSON構文については「JSON構文チェッカー」などの作成したJSON文の記述内容のエラーを検出するサービスが多数存在しますので、そちらを利用すると便利です。
記述ルールの確認
| 確認事項 | 間違った例 | 正しい例 |
|---|---|---|
| {}(波括弧)の整合性が正しいか | {"key": "value" | {'key': "value"} |
| シングルクォーテーションで囲っていないか | {'key': "value"} | {"key": "value"} |
| セミコロンで区切っていないか | {'key'; "value"} | {"key": "value"} |
| 全角スペースが含まれていないか | {"key": "value" } | {"key": "value" } |
| 区切りにカンマ(,)が入っているか | {"key1": "value1" "key2": "value2" } | {"key1": "value1", "key2": "value2" } |
セットする型の確認
JSON構文としてエラーは検出されませんが、型の異なる値をセットした場合、構文エラーと同様の結果が返されます。
| 型の種類 | 間違った例 | 正しい例 |
|---|---|---|
| 数値 | "NumA": "0" | "NumA": 0 |
| 文字 | "ClassA": 3 | "ClassA": "3" |
| bool値 | "CheckA": "true" | "CheckA": true |
| 日付 | "DateA": 2019/01/01 | "DateA": "2019/01/01" |
特殊記号のエスケープ
| エスケープ表記 | 元の文字 | 説明 |
|---|---|---|
\" |
" | ダブルクォーテーション |
\\ |
 |
バックスラッシュ |
\/ |
/ | スラッシュ |
\n |
改行 | |
\t |
タブ |
URLやパスを指定する場合は以下のようにエスケープ処理が必要です。
"http:\/\/ks01.shelterdb.net"
"C:\\files\\image"※円記号・バックスラッシュは、環境により表示が異なります。