Access to the UNL API is managed via service accounts and api-keys. A service account is a special type of account intended to represent a non-human user that needs to access data in a VPM
Service Accounts option from the left side menu or visit https://studio.unl.global/serviceAccounts and click on
Create New Service Account to create & name your service account.
To genereate an API key, select
Create New Api Key from the service account's page. You can copy & manage API keys from a service account's settings page.
The next step is to connect the service account to your Virtual private map. Click on the [...] to select VPM settings from the VPM list page. On the VPM settings page, add your service account by clicking on
Add service account.
The last step is to give the service account contributor rights in order to allow adding data to the project. From the VPM settings page, open the dropdown from the
ROLE column correspoding to your service account and select
Now that a VPM, service account, and api are configured it is possible to make requests to the UNL API. Below is an example forward geocode request.
x-unl-api-key: The api key associated with your service account.
x-project-id: The VPM id that your service account has access to.
address: The input geocode query