سرویس تقسیمات کشوری (استان و شهرستان)

با این سرویس می‌توانید لیست استان‌های ایران را به همراه شناسه‌ (ID) هر استان دریافت کنید و سپس با ارسال شناسه‌ یک استان، لیست شهرستان‌های آن استان را بگیرید. در هر دو حالت، به‌صورت اختیاری می‌توانید محدوده‌ جغرافیایی (geometry) هر منطقه را هم دریافت کنید.

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

اطلاع

1. ۱

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

2. ۲

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

3. ۳

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

4. ۴

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

یادداشت

در صورت ارسال geometry=false (یا ارسال نکردن این پارامتر)، پاسخ فقط شامل شناسه و نام مناطق است. با geometry=true برای هر منطقه فیلد geometry هم بازگردانده می‌شود که پولیگان مرز آن منطقه است و حجم پاسخ را به‌شکل قابل‌توجهی افزایش می‌دهد.

سرویس لیست استان‌ها

آدرس Endpoint

برای دریافت لیست استان‌ها، یک درخواست GET به اندپوینت زیر ارسال کنید:

https://api.neshan.org/v1/region/provinces

هدرهای درخواست (Headers)

Api-Key: <YOUR_API_KEY>

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

پارامتر	نوع داده	توضیحات	نوع پارامتر
geometry	Boolean	با true قرار دادن این پارامتر، به‌همراه لیست استان‌ها، محدوده‌ جغرافیایی هر استان نیز بازگردانده می‌شود.	اختیاری

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

cURL

curl --location 'https://api.neshan.org/v1/region/provinces?geometry=false' \
--header 'Api-Key: <YOUR_API_KEY>'

JavaScript

const myHeaders = new Headers();
myHeaders.append("Api-Key", "<YOUR_API_KEY>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://api.neshan.org/v1/region/provinces?geometry=false", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Java

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.neshan.org/v1/region/provinces?geometry=false")
  .addHeader("Api-Key", "<YOUR_API_KEY>")
  .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.neshan.org/v1/region/provinces?geometry=false");
request.Headers.Add("Api-Key", "<YOUR_API_KEY>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Python

import requests

url = "https://api.neshan.org/v1/region/provinces?geometry=false"

headers = {
    'Api-Key': '<YOUR_API_KEY>'
}

response = requests.get(url, headers=headers)

print(response.text)

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.neshan.org/v1/region/provinces?geometry=false',
  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',
  CURLOPT_HTTPHEADER => array(
    'Api-Key: <YOUR_API_KEY>'
  ),
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;

?>

فرمت پاسخ

پاسخ سرویس یک آرایه از آبجکت‌های استان است. در نمونه‌ زیر، برای اختصار تنها چند استان اول نمایش داده شده است:

[
  {
    "id": 3581,
    "name": "استان یزد"
  },
  {
    "id": 3641,
    "name": "استان لرستان"
  },
  {
    "id": 3595,
    "name": "استان اصفهان"
  },
  {
    "id": 3682,
    "name": "استان خوزستان"
  },
  ...
]

اجزای پاسخ

پارامتر	توضیحات
id	شناسه‌ عددی هر استان. این مقدار ورودی سرویس لیست شهرستان‌ها است.
name	نام استان.
geometry	محدوده‌ جغرافیایی استان (تنها در صورت ارسال geometry=true).

سرویس لیست شهرستان‌های هر استان

آدرس Endpoint

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

https://api.neshan.org/v1/region/provinces/{provinceId}/cities

هدرهای درخواست (Headers)

Api-Key: <YOUR_API_KEY>

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

پارامتر	نوع داده	توضیحات	نوع پارامتر
provinceId	Integer	شناسه‌ عددی استان که در مسیر (Path) درخواست قرار می‌گیرد. این مقدار از فیلد id در خروجی سرویس لیست استان‌ها به‌دست می‌آید.	اجباری
geometry	Boolean	با true قرار دادن این پارامتر، به‌همراه لیست شهرستان‌ها، محدوده‌ جغرافیایی هر شهرستان نیز بازگردانده می‌شود.	اختیاری

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

cURL

curl --location 'https://api.neshan.org/v1/region/provinces/3581/cities?geometry=false' \
--header 'Api-Key: <YOUR_API_KEY>'

JavaScript

const myHeaders = new Headers();
myHeaders.append("Api-Key", "<YOUR_API_KEY>");

const provinceId = 3581;

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch(`https://api.neshan.org/v1/region/provinces/${provinceId}/cities?geometry=false`, requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Java

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

OkHttpClient client = new OkHttpClient();

int provinceId = 3581;

Request request = new Request.Builder()
  .url("https://api.neshan.org/v1/region/provinces/" + provinceId + "/cities?geometry=false")
  .addHeader("Api-Key", "<YOUR_API_KEY>")
  .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;

var client = new HttpClient();

int provinceId = 3581;
string url = $"https://api.neshan.org/v1/region/provinces/{provinceId}/cities?geometry=false";

var request = new HttpRequestMessage(HttpMethod.Get, url);
request.Headers.Add("Api-Key", "<YOUR_API_KEY>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Python

import requests

province_id = 3581
url = f"https://api.neshan.org/v1/region/provinces/{province_id}/cities?geometry=false"

headers = {
    'Api-Key': '<YOUR_API_KEY>'
}

response = requests.get(url, headers=headers)

print(response.text)

PHP

<?php

$provinceId = 3581;
$url = "https://api.neshan.org/v1/region/provinces/{$provinceId}/cities?geometry=false";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => $url,
  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',
  CURLOPT_HTTPHEADER => array(
    'Api-Key: <YOUR_API_KEY>'
  ),
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;

?>

فرمت پاسخ

پاسخ سرویس یک آرایه از آبجکت‌های شهرستان است. در نمونه‌ زیر، برای اختصار تنها چند شهرستان اول استان یزد نمایش داده شده است:

[
  {
    "id": 3382,
    "name": "یزد"
  },
  {
    "id": 1676,
    "name": "هرات"
  },
  {
    "id": 3398,
    "name": "احمدآباد"
  },
  ...
]

اجزای پاسخ

پارامتر	توضیحات
id	شناسه‌ عددی هر شهرستان.
name	نام شهرستان.
geometry	محدوده‌ جغرافیایی شهرستان (تنها در صورت ارسال geometry=true).

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

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