API キーについて
Geolonia の地図をみなさんのウェブサイトでご利用いただくには、API キーを取得していただく必要があります。
API キーは、Geolonia の地図と紐付けられており、API キーを所得する際には実際に地図をご利用されるサイトの URL をダッシュボードでご登録して頂く必要があります。これは、悪意がある第三者による API キーの盗用を防ぐために必要なので、あらかじめご理解をお願いいたします。
ひとつの API キーに対しては、複数の URL を登録していただくことが可能なので、ローカル開発環境やステージング環境なども登録しておくとよいでしょう。
また、ひとつのユーザーアカウントで複数の API キーを取得していただくことも可能です。
開発環境での利用について
API キーを、テスト環境の https://*.test
及び、http://127.0.0.1:<ポート番号>
や http://localhost:<ポート番号>
などのローカル環境で使用した場合、料金が発生しないように設定していますので、安心して開発していただくことができます。
以下の URL に対してはデフォルトでアクセスを許可していますので、API キー作成時に特別な指定をせずにすぐお試し頂くことができます。
対象となる URL および サービス
http://127.0.0.1:*
http://localhost:*
https://*.test
(http
も対応、全てのポート番号対応)https://*.example
(http
も対応、全てのポート番号対応)- GitHub Pages(
https://*.github.io
) ※ 独自ドメインは対象外。 - Netlify (
https://*.netlify.com
,https://*.netlify.app
) ※ 独自ドメインは対象外。 - CodePen
- JSFiddle
- CodeSandbox
- PLAYCODE
- URL は、スキーマも含めて一致する必要があります。たとえば、
http://127.0.0.1:8000
では利用可能ですが、https://127.0.0.1:8000
ではスキーマが違う (http
とhttps
) ため利用できません。 - 上記の URL で表示された地図へのアクセスは、ダッシュボードの地図表示回数から除外されます。
YOUR-API-KEY について
Geolonia のドキュメンテーションやサンプルでは、YOUR-API-KEY
という API キーがサンプルとして使用されています。
この API キーは、 「対象となる URL および サービス」で指定された URL で動作するように許可していますので、サインアップしなくてもすぐにお試しいただくことができます。
YOUR-API-KEY
を使用した地図に限りiFrame
内での利用を禁止させていただいております。