1. ホーム
  2. rest

[解決済み] ヘッダーやURLにAPIキーを配置する

2023-05-03 15:44:50

質問

自分の会社のデータに対する公開APIを設計しています。アプリケーション開発者にAPIキーにサインアップしてもらい、使用状況や使いすぎを監視できるようにしたいと考えています。

APIはRESTなので、最初に考えたのは、このキーをカスタムヘッダに入れることです。これは、Google、Amazon、および Yahoo がそうするのを見たことがある方法です。一方、私の上司は、キーが単に URL などの一部になるなら、API はより簡単に使用できると考えています。 http://api.domain.tld/longapikey1234/resource "です。それはそれでいいのでしょうが、URL は欲しいものを示す単純なアドレスであり、どのように、あるいはなぜ欲しいのかを示すものではないという原則に反しています。

URL にキーを置くことは論理的だと思いますか?あるいは、あるデータに対して単純な javascript のフロントエンドを書く場合、手動で HTTP ヘッダーを設定する必要はないでしょうか?

どのように解決するのですか?

HTTP Authorizationヘッダに記述する必要があります。 仕様書はこちらです。 https://www.rfc-editor.org/rfc/rfc7235