Web APIについて

roadmanでは、Web APIを公開しています。 roadmanのユーザーは、利用規約 に違反しない限り、Web APIを使ったアプリケーションを特別な許可なしに自由に開発、配布、および商用使用することができます。

以下のページで設定したAPIトークン、およびユーザーIDをもとに、Web APIを使うことができます。

アカウントの設定

[1] ユーザーとしての認証

ユーザーとしての認証を行い、認証を表すトークン（認証トークン）を返します。

{HTTPメソッド}	GET|POST（区別されない）
{URL}	https://roadman.r5n.org/api/api/auth/post
{ボディ}	{ "token_api": {token_api}, "user_id": {user_id} }
{レスポンス/成功}	{ "expir_auth": {expir_auth}, "status": "success" , "token": {token} }
{レスポンス/エラー}	{ "cause": {text} , "status": "error" }

各パラメーターは以下のようです。

{パラメーター名}	{型}	{説明}
token_api	string	APIトークン（アカウントの設定 のページで設定）
user_id	string	ユーザーID（....）
expir_auth	string	認証の有効期限（認証から12時間）・yyyy-mm-dd hh:mm:ss
status	string	状態
token	string	認証トークン
cause	string	エラーの原因

[2] 認証の一覧

現在有効な、Web APIを介した認証の一覧です。

{HTTPメソッド}	GET|POST（区別されない）
{URL}	https://roadman.r5n.org/api/api/auth/get
{ヘッダー}	Authorization: Bearer {token_auth}
{レスポンス/成功}	[ { "expir_auth": {expir_auth}, "t_create": {t_create} , "token": {token} }, .... ]
{レスポンス/エラー}	{ "cause": {text} , "status": "error" }

各パラメーターは以下のようです。

{パラメーター名}	{型}	{説明}
Authorization		認証トークン
expir_auth	string	認証の有効期限（認証から12時間）・yyyy-mm-dd hh:mm:ss
t_create	string	作成日時・yyyy-mm-dd hh:mm:ss
token	string	認証トークン
cause	string	エラーの原因
status	string	状態

[3] 認証の削除

Web APIを介した認証を削除します。 配列を受け取り、それらは同時に削除されます。

{HTTPメソッド}	GET|POST（区別されない）
{URL}	https://roadman.r5n.org/api/api/auth/delete
{ヘッダー}	Authorization: Bearer {token_auth}
{ボディ}	[ { "token": {token} }, .... ]
{レスポンス/成功}	{ "status": "success" }
{レスポンス/エラー}	{ "cause": {text} , "status": "error" }

各パラメーターは以下のようです。

{パラメーター名}	{型}	{説明}
Authorization		認証トークン
token	string	認証トークン
status	string	状態
cause	string	エラーの原因

[4] 道路図面の作成

道路図面を作成し、そのデータをダウンロードするためのURLを返します。

{HTTPメソッド}	GET|POST（区別されない）
{URL}	https://roadman.r5n.org/diagram/api/diagram/post
{GETパラメーター}	[test_api={bool}]
{ヘッダー}	Authorization: Bearer {token_auth}
{ボディ}	{ "latitude": {latitude} , "longitude": {longitude}, "theta": {angle} , "width": {width} , "format": { "color_build": null|{color} , "color_frame": null|{color} , "color_road_comp": null|{color} , "color_road_edge": null|{color} , "dash_line": {dash_line} , "diagram_type": "fods"|"ods"|"xls"|"xlsx", "height": {height} , "left": {margin} , "sheet_diagram": {sheet} , "top": {margin} , "width": {width} , "width_line": {width_line} } }
{レスポンス/成功}	{ "status": "success", "url": {url} }
{レスポンス/エラー}	{ "cause": {text} , "status": "error" }

各パラメーターは以下のようです。

{パラメーター名}	{型}	{説明}
test_api		Web APIをテストする（空のデータが返され、クレジットは更新されない）
Authorization		認証トークン
latitude	number	緯度（度）・19.0～47.0
longitude	number	経度（度）・121.0～155.0
theta	number	回転（度）
width	number	描画範囲の幅（m）・>0.0～1000.0（高さは図面の幅、および高さの比率から自動的に決まる）
format/color_build	null|string	線の色/建物・#rrggbb・nullの場合、描画されない
format/color_frame	null|string	線の色/枠・#rrggbb....
format/color_road_comp	null|string	線の色/道路の構成線・#rrggbb....
format/color_road_edge	null|string	線の色/道路の縁・#rrggbb....
format/dash_line	number	点線の長さ（mm）・0.0～20.0・0.0の場合、実線になる
format/diagram_type	string	形式
format/height	number	高さ（mm）....
format/left	number	余白/左（mm）・0.0～1000.0
format/sheet_diagram	string	シート名
format/top	number	余白/上（mm）....
format/width	number	幅（mm）・>0.0～2000.0
format/width_line	number	線の幅（mm）・0.0～20.0・0.0の場合、描画されない
status	string	状態
url	string	データのURL
cause	string	エラーの原因

[5] 道路図面のダウンロード

「道路図面の作成」で作成した道路図面のデータをダウンロードします。

{HTTPメソッド}	GET|POST（区別されない）
{URL}	https://roadman.r5n.org/diagram/api/cache/{cache_id}/get
{ヘッダー}	Authorization: Bearer {token_auth}
{レスポンス/成功}	{data}
{レスポンス/エラー}	{ "cause": {text} , "status": "error" }

各パラメーターは以下のようです。

{パラメーター名}	{型}	{説明}
Authorization		認証トークン
cause	string	エラーの原因
status	string	状態

関連するページ