Getting started
Authentication
Every request carries an API key. Calls draw on the monthly usage units of the key owner's plan.
Send your key
The recommended way is the Authorization header:
Authorization: Bearer YOUR_API_KEY
Where headers can't be set — tile URLs inside a map style, image tags, some SDKs — pass it as a query parameter instead. X-API-Key works too.
https://orviamaps.ir/api/v1/tiles/12/2632/1611.pbf?key=YOUR_API_KEY
Managing keys
Create and revoke keys in your account under API keys. A key is shown once when it's created; only a hashed copy is stored, so a lost key can't be recovered — create a new one and revoke the old one. How many keys you can hold depends on your plan.
Keeping keys safe
A key used in a browser or a mobile app can be read by its users. Map tiles need it on the device; for search, geocoding and routing, call Orvia from your own server (see the Next.js, Nuxt, Laravel and Python guides) and keep that key secret.