NaviConURL発行APIを利用するには、お客様ごとのAPIキーが必要です。
お客様のAPIキー
ログインしてご確認してください
※APIキーは本人確認として使用しますので、情報の取り扱いにご注意ください。
会員登録されていないお客様はこちらから会員登録をお願いします。
利用可能なメソッドは以下です。
POST
リクエストは、次の形式のURLです。SSLはセキュリティ上問題があるためサポートしていません。TLSをご利用ください。
https://dev.navicon.com/webapi/cmd/navicon/createNaviConURL
リクエストパラメータ一覧
※絵文字や一部の第３第４水準漢字など、UTF-8で4バイトとなる特殊文字は利用できません。
| パラメータ名 | パラメータ名称 | 必須 | デフォルト値 | 設定内容 | |
|---|---|---|---|---|---|
| output | レスポンス形式 | json |
レスポンス形式として、以下のいずれかを指定します。 json：JSON形式の出力を行う場合 xml：XML形式の出力を行う場合 |
||
| apikey | APIキー | ○ |
上記の「1.APIキーの確認」で取得したAPIキーを指定します。 APIキーはお客様を識別するコードとなります。 |
||
| regid | 用途ID | ○ |
利用する用途を識別する用途IDを指定します。 指定可能な用途は、NaviCon用のみで、他のサービス用の用途は指定できません。 会員メニューの「用途管理」から用途の登録が必要です。 |
||
| ver | スキーマバージョン | ○ |
発行するNaviConURLのスキーマバージョンを指定します。 [指定可能なバージョン]2.0 |
||
| text | 起動メッセージ |
起動メッセージを設定します。 起動メッセージは、NaviCon起動時に地図画面上にオンスクリーンで表示されます。 |
|||
| devkey | 機器認証キー |
送信を許可する車載機器を限定するための機器認証キーを設定します。 複数指定する場合は "_" で連結して指定します。最大で64個まで指定可能です。 このパラメータは特定の車載器専用アプリが利用するパラメータであり、 それ以外では原則ご利用いただけません。 |
|||
| secure | セキュアタイプ有無 | 0 |
NaviConURLのタイプ（オープンタイプ/セキュアタイプ）を指定します。 0：オープンタイプ 1：セキュアタイプ |
||
| callurl | 戻り先URL | △ |
NaviConがカーナビに地点情報を転送した後に遷移する戻り先URLを設定します。 （セキュアタイプ専用項目の stealth に1を指定した時は、必須となります） |
||
| 地点1の設定 | |||||
| name1 | 地点1の地点名称 | ○ |
地点1の地点名称を設定します。 |
||
| address1 | 地点1の住所 | △ |
地点1の住所を設定します。（coordinates1とどちらか一方は必須です） |
||
| tel1 | 地点1の電話番号 |
地点1の電話番号を設定します。 半角数字（0～9）、+、-、*、#で表される番号のみを設定します。 なお、+と#に限りUTF-8エンコードした値を入力して下さい。 （+を記載する場合は%2b、#を記載する場合は%23と入力） 例1） +81566255511の場合 tel=%2b81566255511 例2） 0566255511#1234の場合 tel=0566255511%231234 |
|||
| linkurl1 | 地点1の関連URL |
地点1に関連するURL（店舗や施設のウェブサイト）を設定します。 http://もしくはhttps://から始まる文字列を設定します。 最大1024文字です。 |
|||
| coordinates1 | 地点1の緯度・経度 | △ |
地点1の緯度・経度を設定します。（address1とどちらか一方は必須です） 緯度と経度の間はカンマ（,）で区切り指定します。 指定範囲は、それぞれ-90.0≦緯度≦90.0、-180.0≦経度≦180.0 の値を設定します。 カーナビ送信時及びセキュアタイプでURLを生成した場合は、小数点以下6桁までが有効となります。 |
||
| 地点2の設定 |
地点2～5までは任意です。 設定値は地点1と同様となります。 各地点とも、「地点名称」と「住所 または 緯度経度」が必須となります。 地点を設定しない場合は、その地点のパラメータは全て未設定としてください。 | ||||
| name2 | 地点2の地点名称 | △ | |||
| address2 | 地点2の住所 | △ | |||
| tel2 | 地点2の電話番号 | ||||
| linkurl2 | 地点2の関連URL | ||||
| coordinates2 | 地点2の緯度・経度 | △ | |||
| 地点3の設定 | |||||
| name3 | 地点3の地点名称 | △ | |||
| address3 | 地点3の住所 | △ | |||
| tel3 | 地点3の電話番号 | ||||
| linkurl3 | 地点3の関連URL | ||||
| coordinates3 | 地点3の緯度・経度 | △ | |||
| 地点4の設定 | |||||
| name4 | 地点4の地点名称 | △ | |||
| address4 | 地点4の住所 | △ | |||
| tel4 | 地点4の電話番号 | ||||
| linkurl4 | 地点4の関連URL | ||||
| coordinates4 | 地点4の緯度・経度 | △ | |||
| 地点5の設定 | |||||
| name5 | 地点5の地点名称 | △ | |||
| address5 | 地点5の住所 | △ | |||
| tel5 | 地点5の電話番号 | ||||
| linkurl5 | 地点5の関連URL | ||||
| coordinates5 | 地点5の緯度・経度 | △ | |||
| セキュアタイプ専用項目 (secure=1 を指定時のみ指定可能なパラメータです） | |||||
| stealth | ステルスモードフラグ | 0 |
ステルスモードを指定します。 ステルスモードを指定することで、NaviConの操作をバイパスして、地点情報がダイレクトにカーナビに転送されます。 0：ステルスOFF 1：ステルスON (ステルスONのときは、callurlの指定が必須です) |
||
HTTPステータスコード
| HTTPステータスコード | 内容 |
|---|---|
| 200 |
リクエストを受け付けした場合に返します 処理結果が正常かエラーであったかは、レスポンス項目「ret」で確認ください |
| 405 |
POSTメソッド以外でリクエストをした場合に返します |
| 500 |
サーバの問題によって、処理できない場合に返します |
| 503 |
サーバへの接続数が多過ぎて、処理できない場合に返します |
レスポンスは、下記の項目を、指定された形式で返します。
| パラメータ名 | パラメータ名称 | 設定内容 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ret | 戻り値 |
0：正常 1：内部処理に失敗 2：入力パラメータエラー |
||||||||||||||||
| code | 詳細コード |
|
||||||||||||||||
| message | エラーメッセージ |
|
||||||||||||||||
| urlschema | 生成されたNaviConURL |
生成されたNaviConURL ・エラーの場合は、null （XMLの場合は空） |
ステルスモードを使用すると、URLからNaviConが起動された際、NaviConの地図画面を表示せずに地点情報をダイレクトにカーナビへ転送し、
地点転送後は自動的に呼び出し元アプリへ遷移します。
このため、ユーザに対して、あたかも呼び出し元アプリ内で地点転送しているかのように見せることができます。
１．ステルスモードを利用したい用途（アプリ）について、セキュアタイプURLの利用登録をしてください。
２．NaviConURL発行APIを利用する際に、以下のパラメータを指定してください。
・secure： 1
・stealth： 1
・callurl： 通常はNaviConの呼び出し元アプリを起動するURLを指定します。
３．発行されたNaviCon URLを、アプリからNaviConを起動する際に使用してください。
NaviConがステルスモードで起動された際にエラーが発生した場合は、
callurlで指定されたアプリを起動する際に原因を表すエラーコードを合わせて返却します。
これにより、呼び出し元アプリは、エラー内容に合わせた動作をすることが可能となります。
| エラーコード | 内容 |
|---|---|
1 |
コマンドエラー |
2 |
認証に失敗 |
3 |
カーナビとの通信に失敗 |
4 |
ネットワーク接続に失敗 |
5 |
NaviCon内部処理に失敗 |
| 対応するエラーコード | 詳細コード | 内容 |
|---|---|---|
1 | 01 |
URLのドメイン名もしくはコマンド名が間違っている |
02 |
URLのデコードに失敗した |
|
15 |
パラメータ”ver”がない |
|
16 |
パラメータ"data"がない |
|
20 |
パラメータ"ver"の形式が不正である |
|
21 |
戻り先URLが不正である |
|
25 |
パラメータ"data"の内容が不正である |
|
26 |
パラメータ"ver"がNaviConで対応しているバージョンよりも上である |
|
27 |
パラメータ"ver"がNaviConで対応しているバージョンよりも下である |
|
2 | 02 |
機器認証キーによる認証に失敗した |
03 |
正規に発行されたURLでない |
|
3 | 01 |
通信環境等によりカーナビと通信できなかった |
02 |
カーナビからエラー応答があった |
|
4 | 01 |
通信環境等によりネットワーク接続できなかった |
5 | 01 |
地点情報の変換に失敗した |
NaviConが呼び出し元アプリを起動する際に、errornoにエラーコードを、detailパラメータにエラー要因の詳細情報を格納します。
(例) 「callurl」に "sample://callback?id=1”が設定されていた場合に、エラー情報を付与して呼び出し元アプリを起動する場合の例
sample://callback?id=1&errorno=1&detail=25
APIキー:SAMPLE_APIKEY、用途ID:SAMPLE_REGID、バージョン:2.0、地点1の地点名称:株式会社ミックウェア、地点1の住所:兵庫県神戸市中央区浪花町59 神戸朝日ビルディング 25F を指定した場合
POST /webapi/cmd/navicon/createNaviConURL HTTP/1.1 Host: dev.navicon.com Content-Length: 285 Content-Type: application/x-www-form-urlencoded apikey=SAMPLE_APIKEY®id=SAMPLE_REGID&ver=2.0&name1=%E6%A0%AA%E5%BC%8F%E4%BC%9A%E7%A4%BE%E3%83%87%E3%83%B3%E3%82%BD%E3%83%BC &address1=%E6%84%9B%E7%9F%A5%E7%9C%8C%E5%88%88%E8%B0%B7%E5%B8%82%E6%98%AD%E5%92%8C%E7%94%BA1-1
JSON形式を指定した場合
{
"ret":0,
"code":0,
"message":null,
"urlschema":"navicon://navicon.com/setPOI?ver=2.0&code=39c2a&mid=SAMPLE_REGID&addr1=%E6%84%9B%E7%9F%A5%E7%9C%8C%E5%88%88%E8%B0%B7%E5%B8%82%E6%98%AD%E5%92%8C%E7%94%BA1-1&title1=%E6%A0%AA%E5%BC%8F%E4%BC%9A%E7%A4%BE%E3%83%87%E3%83%B3%E3%82%BD%E3%83%BC"
}
XML形式を指定した場合
<?xml version="1.0" encoding="UTF-8"?>
<navicon>
<ret>0</ret>
<code>0</code>
<message></message>
<urlschema>navicon://navicon.com/setPOI?ver=2.0&code=39c2a&mid=SAMPLE_REGID&addr1=%E6%84%9B%E7%9F%A5%E7%9C%8C%E5%88%88%E8%B0%B7%E5%B8%82%E6%98%AD%E5%92%8C%E7%94%BA1-1&title1=%E6%A0%AA%E5%BC%8F%E4%BC%9A%E7%A4%BE%E3%83%87%E3%83%B3%E3%82%BD%E3%83%BC</urlschema>
</navicon>
APIキー:SAMPLE_APIKEY、用途ID:SAMPLE_REGID、バージョン:2.0、地点1の地点名称:株式会社ミックウェア、地点1の住所:兵庫県神戸市中央区浪花町59 神戸朝日ビルディング 25F、セキュアタイプ有無:1、ステルスモードフラグ:1、戻り先URL:denso:// を指定した場合
POST /webapi/cmd/navicon/createNaviConURL HTTP/1.1 Host: dev.navicon.com Content-Length: 327 Content-Type: application/x-www-form-urlencoded apikey=SAMPLE_APIKEY®id=SAMPLE_REGID&ver=2.0&name1=%E6%A0%AA%E5%BC%8F%E4%BC%9A%E7%A4%BE%E3%83%87%E3%83%B3%E3%82%BD%E3%83%BC&address1=%E6%84%9B%E7%9F%A5%E7%9C%8C%E5%88%88%E8%B0%B7%E5%B8%82%E6%98%AD%E5%92%8C%E7%94%BA1-1 &secure=1&stealth=1&callurl=denso%3A%2F%2F
JSON形式を指定した場合
{
"ret":0,
"code":0,
"message":null,
"urlschema":"navicon://navicon.com/setPOISecure?ver=2.0&data=d9KtuAq10001000CZVGuc826L8y.0005LITe050LTeI005eoS5b5-5l5y5MYi6ILC53bi5Cpi5tZK5M5SM6S00xW5Cqq5ybP5yLa5S6-4O4H4O4z4K494O480000"
}
XML形式を指定した場合
<?xml version="1.0" encoding="UTF-8"?>
<navicon>
<ret>0</ret>
<code>0</code>
<message></message>
<urlschema>navicon://navicon.com/setPOISecure?ver=2.0&data=d9KtuAq10001000CZVGuc826L8y.0005LITe050LTeI005eoS5b5-5l5y5MYi6ILC53bi5Cpi5tZK5M5SM6S00xW5Cqq5ybP5yLa5S6-4O4H4O4z4K494O480000</urlschema>
</navicon>