To add your Nearmap subscription to Giraffe, you need the help of your organisation’s Nearmap administrator. If you aren't the admin - share this page with them to get it all set up.
If that's you, keep reading.w your subscription details before proceeding.
Set up an API Application in Nearmap admin portal
Log in to Nearmap at https://admin.nearmap.com/welcome as a user who is a Nearmap administrator.
Click the API Access tab at the top of the screen, then the API Applications. If you do not see the tab, it is likely that you are not a Nearmap administrator.
To create a new API Application, click the Create New button. To edit an API Application, click the Edit Application pencil icon against the application you want to edit.
Enter the Application Name as 'Giraffe'. This can be any string of characters. A good name would describe the integration that you intend to have with Nearmap imagery.
You can optionally specify restrictions on which web sites can load Nearmap imagery via an API Key associated with this API Application:
Referrer restrictions: only URLs that begin with one of the specified referrer prefixes are allowed access to Nearmap imagery. This is based on web browser support for the HTTP referrer header field. Enter http://app.giraffe.build/ & https://app.giraffe.build/
If creating a new API Application, click the Save button.If editing an existing API Application, click the Update button.
Your API Application should be displayed on the screen. Each user on your Nearmap account can now create an API Key for that API Application.
🚨 Using Nearmap in Giraffe may result in charges against your credit-based subscription in Nearmap. Review your subscription details before proceeding.
Retrieve your API key
Log in to Nearmap at https://admin.nearmap.com/welcome.
If you are a normal user, click the My API Keys button.
Choose 'Giraffe' application from the drop-down list. If there is no application in the drop-down list, or the API Application you want is not there, contact your organisation's Nearmap administrator.
Click Create API Key.
The API Key is now created – it is the long string of characters in the API Key column. You can use it in your integrations, as explained in Using an API Key in Nearmap Integrations.
Set up the Giraffe Layer
To view your Nearmap subscription in Giraffe, you will need to make a custom layer. It doesn't really matter what the layer is - as we will be editing the underlying JSON once the layer is created. The steps below will help with this:
To create a Layer:
- Open Giraffe and select New Layer (left hand bar)
- Create a new Mapserver layer by selecting: Create Your Own → ESRI Map Server from the drop down. Use the following URL to create a map server layer https://geo.abs.gov.au/arcgis/rest/services/ASGS2022/LGA/MapServer
Now edit the layer:
click 3 dots next to the new layer and select Manage
then the Edit Style JSON button
This window will open:
We need to replace the JSON in the layer just created with this snippet below.
Copy & paste the code snippet below
make sure to replace <NEARMAPS_API_KEY> with the API key we created in the previous steps.
[{
"id": "Nearmap",
"paint": {},
"source": {
"tiles": [
"https://api.nearmap.com/tiles/v3/Vert/{z}/{x}/{y}.jpg?apikey=<NEARMAPS_API_KEY>"
],
"type": "raster"
},
"type": "raster"
}]
Hit save & you've created a layer!