کلیدها و احراز هویت — مستندات

ارسال کلید

کلید را در هدر X-Api-Key بفرستید، یا در پارامتر key. اگر هر دو باشد، هدر اولویت دارد.

curl -H "X-Api-Key: um_sk_..." "https://api.uttamap.ir/v1/reverse?lat=35.6997&lng=51.3380"

برای تایل، استایل، فونت و sprite فقط پارامتر key کار می‌کند، چون MapLibre هدر دلخواه نمی‌فرستد. URLهای داخل style.json کلید را خودشان دارند.

کلید مخفی و کلید عمومی

	کلید مخفی `um_sk_`	کلید عمومی `um_pk_`
جای استفاده	فقط سرور شما	مرورگر و اپ موبایل
محدودیت الزامی	ندارد (اختیاری: IP)	دامنه‌های مجاز یا شناسهٔ اپ
اگر از مرورگر بیاید	رد با `secret_key_in_browser`	مجاز، اگر Origin در فهرست باشد

دامنه را با پروتکل بنویسید، مثل https://shop.example.ir. برای همهٔ زیردامنه‌ها https://*.example.ir. برای اپ، شناسهٔ بسته (مثل ir.example.app) را در فهرست اپ‌ها بگذارید و اپ آن را در هدر X-Uttamap-App بفرستد.

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

سقف روزانه و سرویس‌های مجاز

برای هر کلید می‌توانید سرویس‌های مجاز را محدود کنید (مثلاً فقط tile و search) و برای هر سرویس سقف روزانه بگذارید. بعد از رسیدن به سقف، پاسخ 429 daily_cap_reached برمی‌گردد و روز بعد (به وقت تهران) باز می‌شود.

لغو کلید

کلید لو رفته را از پیشخوان لغو کنید. لغو در کمتر از یک دقیقه در همهٔ سرورها اعمال می‌شود.