Skip to content

APIの概要

API Endpoint

APIエンドポイントのurlは下記です（要調査事項）。

環境 Base url 説明
Live https://hogehoge.org/api/ ---
Dev https://fugafuga.org/api/ ---

認証とコール方法

APIコールを行う際に、認証情報をAPIサーバに送る方法は、ログイン時に発行されセッションクッキーに格納されるセッション固有文字列（ACCESS_TOKEN）をAPIコール時にHTTP-Headerに込める方式です。

cUrlでのAPIコールの例（GET）
1
2
curl -X GET "https://example.com/api/resource" \
    -H "Authorization: Bearer ACCESS_TOKEN"
cUrlでのAPIコールの例（POST）
1
2
3
4
curl -X POST "https://example.com/api/resource" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"key1":"value1","key2":"value2"}'

RESTful API視点での実装状況

RESTful APIではHTTP Methodと行うことを紐付けていますが、現状ではPOSTでデータ削除を行ったりとRESTfulとは言えない仕様が散見されます。すべてを突然変えるのは困難なので、可能な範囲で摺り寄せていければよいのではないでしょうか。

HTTP Method Description
GET Fetch resource データの取得
POST Create resource データの送信 (主に新規作成)
PUT Update resource データの送信 (主に既存データの更新) 実装なし
DELETE Delete resource データの削除 実装なし
PATCH Partially update resource データの送信 (主に既存データの一部更新) 実装なし
OPTIONS Confirm available methods データの取得 (使用可能なメソッド閲覧) 実装なし
HEAD Confirm alive データの取得 (レスポンスヘッダー閲覧) 実装なし
TRACE Confirm server path データの取得 (サーバーパス閲覧) 実装なし