地図情報取得API:Auth
- 公開日
- 更新日 2024-11-19
利用条件
概要
API名称
カテゴリー
説明
本APIはNTTインフラネット株式会社の地図情報を取得する為のAPIです。 本APIの利用には、NTTインフラネット株式会社とのライセンス契約が必要となります。 ライセンス契約につきましては、下記の担当までお問い合わせください。
wagri-ml@nttinf.co.jp NTTインフラネット株式会社 Smart Infra推進部 GIS営業担当
添付ファイル
ー
データの更新頻度
リクエスト
新URL
New!
ー
旧URL(2025年度末で終了予定)
https://api.wagri.net/API/Public/Map/Auth/Validate/{username}/{authenticationKey}
説明
画像を取得するための認証を提供します。 ※認証時間は12時間で無効となります。12時間以内に再取得をしてください。
HTTPメソッド
パラメータ
URLデータ定義
GEOSPACE CDS 認証処理のパラメータ
| 名称 | 値 | 型 | 値の説明 |
|---|---|---|---|
| username | 認証対象ユーザ名。管理者より提供されたユーザ名 | string | Required |
| authenticationKey | 認証対象のユーザが持つ認証キー | string | Required |
新呼出例
New!
ー
旧呼出例(2025年度末で終了予定)
ー
レスポンス
レイアウト
レスポンスデータ定義
GEOSPACE CDS 認証処理のレスポンス
| 名称 | 値 | 型 | 値の説明 |
|---|---|---|---|
| enableaccesstime | 承認有効期限。画像取得サービスアクセス用一時キーの使用可能期限この時間が切れると、アクセス用一時キーは使用不可と なる。この時間は JST(日本時間)で表される。期間は 12時間とする。 | string | Required |
| authorizeKey | アクセス認可用キー。画像取得サービスのアクセスに使用する認可キー | string | Required |
レスポンス例
ー
ステータスコード
| コード | 名称 | 値の説明 |
|---|---|---|
| 400 | Bad Request | リクエストが不正です。 |
| 401 | Unauthorized | 認証情報が不正です。 |
| 403 | Forbidden | リソースのアクセスが禁止されています。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
サンプルソースコード
プログラム記述例(WAGRI共通)
import requests
url = "https://api.wagri.net/API/Public/AgriculturalLand/SearchByCityCode"
payload = {
'CityCode': '432041'
}
headers = {
'X-Authorization': 'アクセストークン',
}
response = requests.get(url, headers=headers, params=payload)
print(response.text)
プログラム記述例(個別API)
コード例 JavaScript
Geospace CDS を利用する為には認可キーが必要になりますが、認可キーは一定期間で 有効期限が切れるため、定期的に更新する必要があります。 通常は認証 Web サービス「Validate」にアクセスする事で取得できますが、インター フェースが JSON である為クロスドメイン問題への対処が必要です。 そこで、クロスドメイン問題及び JSONP へ対応するため、サーバサイド実装を行いま す。 cron により、一定間隔で認可キーを更新し.cds.key ファイルへ内容を書き込み、 geospaceCDSkey.php で読み込んで JSONP として返します。 (※ unix 系 OS 及び php により実装しています)
●crontab(ユーザ名と認証キーは置き換えてください)
1 * * * * wget --no-check-certificate -O /var/www/html/api/.cds.key https:// cds.geospace.jp/auth/Validate/[ユーザ名]/[認証キー]
●geospaceCDSkey.php
<?php
/**
* GeospaceCDS の認可キーを読み込んで返却する
* JSONP 対応
* .cds.key ファイルは毎時 cron にて書き換えられる
*/
$key = @file_get_contents(".cds.key");
header("application/json");
header("Expires:Mon, 26 Jul 1997 05:00:00 GMT");
header("Last-Modified: ".gmdate("D, d M Y H:i:s")."GMT");
header("Cache-Control: no-store,no-cache, must-revalidate");
header("Cache-Control: post-check=0, pre-check=0",false);
header("Pragma: no-cache");
if(isset($_GET["callback"])){
echo $_GET["callback"]."(".$key.");";
} else {
echo $key;
}
?>

