نقشه استاتیک با امکان رسم کمان بین مبدا و مقصد

اطلاع

1. ۱

   اولین قدم ثبت‌نام و دریافت API KEY برای اپلیکیشنی است که قصد دارید در آن از Map Api نشان استفاده کنید. کافیست در لینک فوق فرم مربوطه را تکمیل کنید تا بلافاصله API KEY را دریافت نمایید.

2. ۲

   Api Key دریافتی از پنل توسعه‌دهندگان نشان را به صورتی که در ادامه مشاهده می‌کنید از طریق کلید Api-Key در header درخواست سرویس بگنجانید.

3. ۳

   درخواست خود را با توجه به پارامترهایی که مربوط به سرویس موردنظرتان است با متد GET فراخوانی کنید.

4. ۴

   چنانچه درخواست شما با موفقیت پردازش و پاسخ داده شود، خروجی با فرمت JSON دریافت خواهید کرد و چنانچه به هر دلیل خطایی رخ دهد، کد خطا بصورت HTTP Status Code و نوع آن با فرمت JSON ارسال می‌گردد. کدهای خطای احتمالی نیز در ادامه به صورت کامل توضیح داده شده‌اند.

شیوه‌ فراخوانی

با استفاده از آدرس تولید تصویری از نقشه با ابعاد و موقعیت موردنظرتان امکان پذیر می‌باشد:

https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018,38.073362&to=60.649445,25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56

پارامترهای ورودی

• key: کلید اختصاصی که از پنل توسعه‌دهندگان نشان دریافت کرده‌اید.
• type: استایل نقشه که یکی از مقادیر neshan ، standard-day ، standard-night ، dreamly-gold ، dreamy و osm-bright می‌تواند باشد.
• from:نقطه مبدا خط کمان که بصورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.
• to: نقطه مقصد خط کمان که بصورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.
• width: عرض تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
• height: ارتفاع تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
• dashed:  این پارامتر استایل خط کمان را مشخص می‌کند و اختیاری بوده و مقادیر آن true یا false می‌تواند باشد. در صورتی که این پارامتر true باشد، خط کمان به صورت خط‌چین نمایش داده می‌شود.
• color: رنگ خط کمان را مشخص می‌کند، مقدار آن به صورت هگز وارد می شود.
• marker1Token: آیکن ماکر مبدا کمان را مشخص می‌کند.مقدار آن توکن فایل آپلود شده در قسمت آیکن های پروفایل می باشد.
• marker2Token: آیکن ماکر مقصد کمان را مشخص می‌کند.مقدار آن توکن فایل آپلود شده در قسمت آیکن های پروفایل می باشد.

نمونه درخواست

cURL

curl --location 'https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018%2C38.073362&to=60.649445%2C25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56'

javascript

const urlencoded = new URLSearchParams();

const requestOptions = {
method: "GET",
body: urlencoded,
redirect: "follow"
};

fetch("https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018,38.073362&to=60.649445,25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));

java

OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018,38.073362&to=60.649445,25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56")
.method("GET", body)
.build();
Response response = client.newCall(request).execute();

c#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018,38.073362&to=60.649445,25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

python

import requests

url = "https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018,38.073362&to=60.649445,25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56"

payload = {}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.neshan.org/v4/static/arc?key=YOUR_API_KEY&type=standard-night&from=46.298018%2C38.073362&to=60.649445%2C25.292741&width=600&height=600&dashed=true&color=%23FF0AA5&marker1Token=101139.nRmybq56&marker2Token=101139.nRmybq56',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

خروجی تولید شده با ارسال درخواست:

با مراجعه به صفحه ابزار رسم کمان می‌توانید به سادگی و با چند کلیک بر روی نقشه تصویر کمان بین دو نقطه را ایجاد نمائید و سپس در وب‌سایت یا اپلیکیشن خود استفاده نمایید.

تـوجه! جهت آپلود فایل برای تصویر مارکر های مبدا و مقصد دلخواه به صفحه زیر در پروفایل خود مراجعه بفرمایید. پس از آپلود هر تصویر توکنی در اختیار شما قرار میگیرد که زمان فراخوانی سرویس نقشه استاتیک در پارامترهای marker1Token و marker2Token به عنوان مارکر مبدا و مقصد ارسال می شود. https://platform.neshan.org/panel/icons

کد خطاهای سرویس

HTTP Code	Status	Description
404	NOT_FOUND	کد پستی با این مشخصات یافت نشده است
400	INVALID_ARGUMENT	خطا در پارامتر های ورودی
470	CoordinateParseError	چنانچه مختصات جغرافیایی ارسالی معتبر نباشد رخ خواهد داد.
480	KeyNotFound	در صورتی که در فراخوانی وب‌سرویس از یک Api Key نامعتبر استفاده کنید یا Api Key خود را در header ارسال نکنید رخ خواهد داد.
481	LimitExceeded	در صورتی که تعداد فراخوانی وب‌سرویس‌ها از میزان مجازی که برای شما تعیین شده‌است عبور کند رخ خواهد داد.
482	RateExceeded	چنانچه تعداد درخواست وب‌سرویس در دقیقه از حد مجاز عبور کند رخ خواهد داد.
483	ApiKeyTypeError	کلید دسترسی استفاده شده با سرویس فراخوانی شده همخوانی ندارد. بایستی از کلید دسترسی مرتبط با سرویس مورد نظر استفاده کنید.
484	ApiWhiteListError	با توجه به اسکوپ تعریف‌شده برای این کلید، شما مجاز به استفاده نیستید.
485	ApiServiceListError	سرویس فراخوانی شده با سرویس‌های تعریف‌شده برای این کلید دسترسی همخوانی ندارد.
500	GenericError	وقوع خطای ناشناخته