رفتن به محتوا
مستندات فنی

کلید API و دسترسی

برای هر درخواست به APIهای بلد به کلید API نیاز دارید. نوع کلید را بر اساس محل استفاده انتخاب کنید.

کلید خصوصی برای سرور

بخش «کلید خصوصی برای سرور»

کلید خصوصی را فقط در سرور نگه دارید و در هدر درخواست بفرستید:

Authorization: Bearer <BALAD_API_KEY>

هنگام ساخت کلید، سرویس‌های مجاز و IP یا CIDR سرورهای خود را مشخص کنید. کلید خصوصی را در مرورگر قرار ندهید.

کلید عمومی برای مرورگر

بخش «کلید عمومی برای مرورگر»

کلید عمومی قابل مشاهده است. هنگام ساخت، سرویس‌ها و مبدأهای مجاز (Origin) وب‌سایت را محدود کنید.

برای نمایش نقشه، کلید عمومی را در نشانی فایل style قرار دهید:

https://tile-vector.services.balad.ir/styles/vector.json?api_key=<PUBLIC_API_KEY>

برای نمونه، صفحه‌ای که از http://localhost:8000 باز شده است همین مبدأ را دارد. هنگام تنظیم مبدأ مجاز، طرح، نام میزبان و پورت را مطابق نشانی صفحه انتخاب کنید.

کلید خصوصی را در مرورگر قرار ندهید. اگر جستجو یا تبدیل نقطه به آدرس از کلید خصوصی استفاده می‌کند، درخواست آن را از سرور برنامهٔ خود بفرستید.

وضعیت بررسی
401 کلید ارسال نشده است؛ محل ارسال کلید را بررسی کنید.
403 کلید یا سازمان ممکن است غیرفعال باشد؛ سرویس مجاز، IP سرور یا Origin مرورگر را بررسی کنید.

دریافت کلید API · نمایش اولین نقشه · اولین درخواست API