APIキーを取得 | Mapbox GL JS、MapLibre GL JS 互換の Geolonia Maps 公式ドキュメンテーション

API キーについて

Geolonia の地図をみなさんのウェブサイトでご利用いただくには、API キーを取得していただく必要があります。

API キーを取得するには、Geolonia のダッシュボードにサインアップして頂く必要があります。

API キーは、Geolonia の地図と紐付けられており、API キーを取得する際には実際に地図をご利用されるサイトの URL をダッシュボードでご登録して頂く必要があります。これは、悪意がある第三者による API キーの盗用を防ぐために必要なので、あらかじめご理解をお願いいたします。

ひとつの API キーに対しては、複数の URL を登録していただくことが可能なので、ローカル開発環境やステージング環境なども登録しておくとよいでしょう。

また、ひとつのユーザーアカウントで複数の API キーを取得していただくことも可能です。

API キーを、テスト環境の https://*.test 及び、http://127.0.0.1:<ポート番号> や http://localhost:<ポート番号> などのローカル環境で使用した場合、料金が発生しないように設定していますので、安心して開発していただくことができます。

以下の URL に対してはデフォルトでアクセスを許可していますので、API キー作成時に特別な指定をせずにすぐお試し頂くことができます。

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) ※ 独自ドメインは対象外。
Vercel (https://*.vercel.app) ※ 独自ドメインは対象外。
CodePen
JSFiddle
CodeSandbox
PLAYCODE
Web Maker
URL は、スキーマも含めて一致する必要があります。たとえば、http://127.0.0.1:8000 では利用可能ですが、 https://127.0.0.1:8000 ではスキーマが違う (http と https) ため利用できません。
上記の URL で表示された地図へのアクセスは、ダッシュボードの地図表示回数から除外されます。

Geolonia のドキュメンテーションやサンプルでは、YOUR-API-KEY という API キーがサンプルとして使用されています。

この API キーは、「対象となる URL およびサービス」で指定された URL で動作するように許可していますので、サインアップしなくてもすぐにお試しいただくことができます。

地図の表示回数が無料プランの制限を超過した場合、地図の配信が停止されます。なお、上記の無料利用可能な開発環境においては地図の表示回数はカウントされず、無料でご利用いただけます。

地図の表示制限を解除するには、ダッシュボードにサインインしてクレジットカードの登録を行うことで有料プランの申し込みを行うことができます。有料プランではより多くの地図表示回数とそれを超える分の従量課金での地図表示が利用できます。