はじめに

このドキュメントでは、Smart Contest JSON API を構成するリソースについて説明します。

スキーマ

場所

API は https://XXXX.smartcontest.digital/ で利用可能です。レスポンスは JSON 形式で返されます。

サマリーオブジェクト

オブジェクトのリストを取得する際、オブジェクトの省略形またはサマリー版が返されます。これはその属性の一部です。オブジェクトの詳細版を取得するには、個別にフェッチしてください。

HTTP動詞

Unsplash API は、各アクションに適した HTTP 動詞を使用します。

動詞 説明
GET リソースを取得する。
POST リソースを作成する。
PUT リソースを更新する。

エラーメッセージ

エラーが発生した場合、サーバー側またはクライアント側でエラーが発生した場合、エラーメッセージが errors 配列として返されます。例えば：

422 Unprocessable Entity

{
  "errors": ["ユーザー名がありません", "パスワードが空です"]
}

API リクエストの成功や失敗を示すために、標準的な HTTP レスポンスコードを使用しています。

一般的なステータスコード 説明
200 - OK すべて正常に動作しました
400 - Bad Request リクエストが不正です（多くの場合、必要なパラメータが欠けている）
401 - Unauthorized 無効なアクセス・トークン
403 - Forbidden リクエストを実行する権限がありません
404 - Not Found リクエストされたリソースが存在しません
500, 503 サーバー側で問題が発生しました

認証

公開認証

ほとんどのアクションは、特定のユーザーによる認証なしで実行できます。例えば、写真を検索したり、取得したり、ダウンロードしたりすることにはユーザーのログインは必要ありません。

この方法でリクエストを認証するには、HTTP Authorization ヘッダーを通じてアプリケーションのアクセス・キーを渡します：