粗大ゴミ画像識別用の REST API.

画像識別の実行時には、事前に発行された以下の値を使用して認証する. API_KEY ユーザー名 パスワード

まず、ユーザー名とパスワードを使用して認証トークンを取得し、画像識別の実行時にAPI_KEYと認証トークンを使用する. 識別できる粗大ゴミのリストはこちら.

curl による実行例

• 認証トークンの取得 ユーザー名とパスワードを指定して認証トークンを取得する. 画像識別の実行時、この認証トークンを使用する. 認証トークンの有効期限は1時間であるため、有効期限が切れた場合は再取得、もしくはリフレッシュを行う. リフレッシュトークンの有効期限は30日間.

  リクエスト

  $ curl -X POST -H "Content-Type: application/json" \
    -d '{"userName": "<ユーザー名>", "password": "<パスワード>"}' \
    <エンドポイント>/get_token

  レスポンス

  {
    "token":"<認証トークン>",
    "refreshToken":"<リフレッシュトークン>"
  }

• 認証トークンのリフレッシュ リフレッシュトークンを利用して新しい認証トークンを取得する.

  リクエスト

  $ curl -X POST -H "Content-Type: application/json" \
    -d '{"refreshToken": "<リフレッシュトークン>"}' \
    <エンドポイント>/refresh_token

  レスポンス

  {
    "token":"<認証トークン>",
    "refreshToken":"<リフレッシュトークン>"
  }

• 画像識別 BASE64形式に変換した画像を指定し、対象物が何であるか、確信度の高い順にリストで取得する. 認証のため、ヘッダーにAPI_KEYと認証トークンの両方を指定する.

  リクエスト

  $ echo {\"image\": \"$( base64 -i image.jpg )\" } | \
    curl -X POST -H "Content-Type: application/json" \
    -H "x-api-key: <API_KEY>"  \
    -H "Authorization: <認証トークン>"  \
    -d @- \
    <エンドポイント>/classify

  レスポンス

  {
    "results":[
      {
        "label":"ゴミ箱",
        "prob":"0.8123123"
      },
      {
      "label":"冷蔵庫",
      "prob":"0.1023023"
      }
    ]
  }

今後の検討事項

• 画像サイズの下限、上限については運用状況(サイズによる精度、レスポンス時間)を鑑みて決定する.
• 現状では1秒あたりのリクエスト数の上限を10回と想定しているが、仕様状況に応じて変更する.