آخرین نسخهنسخه 2.0.0

سرویس نقشه‌ی استاتیک

اطلاع

صفحه‌ای که در حال مشاهده آن هستید، حاوی مستندات آخرین نسخه سرویس نقشه‌ی استاتیک می‌باشد. مستندات مرتبط با نسخه قدیمی این سرویس را در این صفحه می‌توانید مشاهده کنید.

اطلاع

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?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5

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

• key: کلید اختصاصی که از پنل توسعه‌دهندگان نشان دریافت کرده‌اید.
• type: استایل نقشه که یکی از مقادیر neshan ، dreamy-gold ، dreamy ، standard-day ، standard-night و osm-bright می‌تواند باشد.
• zoom: سطح بزرگنمایی نقشه که حداقل ۵ و حداکثر ۱۹ می‌تواند باشد.
• center: مرکز نقشه که بصورت عرض و طول جغرافیایی و با یک ویرگول در بین آنها ارسال می‌شود.
• width: عرض تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
• height: ارتفاع تصویر موردنظر که حداکثر 1200 پیکسل می‌تواند باشد.
• markerToken: آیکن مرکز عکس را با استفاده از این پارامتر می‌توانید تنظیم کنید. برای ایجاد آیکن دلخواه می‌توانید با مراجعه به پنل کاربری خود، قسمت آیکن ها تصویر مارکر دلخواه را آپلود نمائید، اگر این پارامتر دورن درخواست ارسالی وجود نداشته باشد روی عکس مارکری قرار نمی‌گیرد.

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

cURL

curl --location 'https://api.neshan.org/v4/static?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5'

javascript

const urlencoded = new URLSearchParams();

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

fetch("https://api.neshan.org/v4/static?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5", 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?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5")
  .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?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

python

import requests

url = "https://api.neshan.org/v4/static?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5"

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?key=YOUR_API_KEY&type=neshan&width=500&height=500&zoom=12&center=32.657307%2C51.677579&markerToken=101139.nRmybq5',
  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;

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

ابزار تولید نقشه استاتیک:

برای سهولت کار، ابزار Neshan Static Map Maker طراحی و پیاده‌سازی شده است. شما می‌توانید توسط این ابزار به راحتی فقط با چند کلیک ساده آدرس نقشه‌ی استاتیک موردنظرتان را تولید و سپس در وب‌سایت یا اپلیکیشن خود استفاده نمایید.

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

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	وقوع خطای ناشناخته