roadmanでは、Web APIを公開しています。roadmanのユーザーは、利用規約 に違反しない限り、 Web APIを使ったアプリケーションを特別な許可なしに自由に開発、配布、および商用使用することができます。
以下のページで設定したユーザーID、およびAPIキーをもとに、Web APIを使うことができます。
ユーザーとしての認証を行い、「NO-OP」へのアクセス許可を表すトークン（アクセストークン）を返します。
| {HTTPメソッド} | GET|POST（区別されない） |
| {URL} | https://r5n.org/api/api/auth/post |
| {ボディ} | { "auth_type": "_NOOP_" , "user_id": {user_id}, "api_key": {api_key} } |
| {レスポンス} | { "auth_type": "_NOOP_" , "token": {token} , "config": [] , "expir_auth": {expir_auth} } |
各パラメーターは以下のようです。
| {パラメーター名} | {型} | {説明} |
|---|---|---|
| user_id | string | ユーザーID（Web APIの設定 のページで設定） |
| api_key | string | APIキー（....） |
| token | string | アクセストークン |
| expir_auth | string | 認証の有効期限（認証から1時間）・yyyy-mm-dd hh:mm:ss |
何もしません。（テストのためだけの機能です。）
| {HTTPメソッド} | GET|POST（区別されない） |
| {URL} | https://r5n.org/api/api/noop/post |
| {ヘッダー} | Authorization: Bearer {token} |
| {ボディ} | {} |
| {レスポンス} | {} |
各パラメーターは以下のようです。
| {パラメーター名} | {型} | {説明} |
|---|---|---|
| Authorization | アクセストークン |
ユーザーとしての認証を行い、「道路図面の作成」へのアクセス許可を表すトークン（アクセストークン）を返します。
| {HTTPメソッド} | GET|POST（区別されない） |
| {URL} | https://r5n.org/api/api/auth/post |
| {ボディ} | { "auth_type": "_DIAGRAM_", "user_id": {user_id} , "api_key": {api_key} } |
| {レスポンス} | { "auth_type": "_DIAGRAM_" , "token": {token} , "config": [] , "expir_auth": {expir_auth} } |
各パラメーターは以下のようです。
| {パラメーター名} | {型} | {説明} |
|---|---|---|
| user_id | string | ユーザーID（Web APIの設定 のページで取得） |
| api_key | string | APIキー（....） |
| token | string | アクセストークン |
| expir_auth | string | 認証の有効期限（認証から1時間）・yyyy-mm-dd hh:mm:ss |
道路図面を作成し、そのデータをダウンロードするためのURLを返します。
| {HTTPメソッド} | GET|POST（区別されない） |
| {URL} | https://r5n.org/diagram/api/diagram/post |
| {GETパラメーター} | [test_api={bool}] |
| {ヘッダー} | Authorization: Bearer {token} |
| {ボディ} | { "longitude": {longitude}, "latitude": {latitude} , "theta": {angle} , "width": {width} , "format": { "file": {file} , "suffix_file": {bool} , "diagram_type": "fods"|"ods"|"xls"|"xlsx", "sheet_diagram": {sheet} , "left": {margin} , "top": {margin} , "width": {width} , "height": {height} , "color_frame": null|{color} , "color_road_edge": null|{color} , "color_road_comp": null|{color} , "color_build": null|{color} , "width_frame": {width} , "width_road_edge": {width} , "width_road_comp": {width} , "width_build": {width} , "dash_hidden": {length} , "dash_unwalled": {length} } } |
| {レスポンス} | { "url": {url} } |
各パラメーターは以下のようです。
| {パラメーター名} | {型} | {説明} |
|---|---|---|
| test_api | Web APIをテストする（空のデータが返され、クレジットは更新されない） | |
| Authorization | アクセストークン | |
| longitude | number | 経度（度）・121.0～155.0 |
| latitude | number | 緯度（度）・19.0～47.0 |
| theta | number | 回転（度） |
| width | number | 描画範囲の幅（m）・>0.0～1000.0（高さは図面の幅、および高さの比率から自動的に決まる） |
| format/file | string | ファイル名 |
| format/suffix_file | boolean | ファイル名に日時を付ける |
| format/diagram_type | string | 形式 |
| format/sheet_diagram | string | シート名 |
| format/left | number | 図面の左余白（mm）・0.0～1000.0 |
| format/top | number | 図面の上余白（mm）.... |
| format/width | number | 図面の幅（mm）・>0.0～2000.0 |
| format/height | number | 図面の高さ（mm）.... |
| format/color_frame | null|string | 線の色（枠）・#rrggbb形式・nullの場合、描画されない |
| format/color_road_edge | null|string | 線の色（道路の縁）・#rrggbb形式.... |
| format/color_road_comp | null|string | 線の色（道路の構成線）・#rrggbb形式.... |
| format/color_build | null|string | 線の色（建築物）・#rrggbb形式.... |
| format/width_frame | number | 線の幅（枠・mm）・0.0～20.0・0.0の場合、描画されない |
| format/width_road_edge | number | 線の幅（道路の縁・mm）.... |
| format/width_road_comp | number | 線の幅（道路の構成線・mm）.... |
| format/width_build | number | 線の幅（建築物・mm）.... |
| format/dash_hidden | number | 点線の長さ（遮蔽・mm）・0.0～20.0・0.0の場合、実線になる |
| format/dash_unwalled | number | 点線の長さ（無壁・mm）.... |
| url | string | データのURL |
「道路図面の作成」で作成した道路図面のデータをダウンロードします。
| {HTTPメソッド} | GET|POST（区別されない） |
| {URL} | https://r5n.org/diagram/api/cache/{query} |
| {ヘッダー} | Authorization: Bearer {token} |
| {レスポンス} | {data} |
各パラメーターは以下のようです。
| {パラメーター名} | {型} | {説明} |
|---|---|---|
| Authorization | アクセストークン |