Introduction

This article provides answers to frequently asked API onboarding-related questions.

Tip: For a quick API onboarding guide, you can refer to API - Onboarding. For security topics, you can refer to API - Security topics FAQ. The detailed technical API specification will be shared on request.

Frequently asked questions

Why do you require a technical email address from the customer side?

We use the technical email address of the company to prevent possible situations when a person managing the private email leaves the company.

What data levels are used?

The following structure of the data is used:

• Category
• Service
• Version

Examples:

• "category": "Hazards"
• "service": "NathanEarthquake"
• "version": "current"

What types of data versioning are used?

The following version types are used:

• "previous"
• "current"
• "preview"

Note: Different version types cannot be mixed in one request.

Note: "preview" versions are not counting against the quota.

What is the request model?

• "Items" [Array]: Locations or addresses (max 1000 items per request).
• "Services" [Array]: Category, service, version, and RequestedServiceId (no limit of services per request).

Which endpoints are used?

The following two endpoints are used:

1. location-info: Coordinates or addresses as items.
2. area-line-info: Areas and Lines objects as items.

Both endpoints have POST (data request with defined items and services).

Additional endpoints for location-info and area-line-info:

• /jobs: Batch processing.
• /documentation: Retrieve the data documentation in a PDF format.
• /usage: Retrieve usage statistics.

How much time does it take to set up API on the customer side?

Depends on the complexity of the customer's IT. As usual, it takes less than a week. However, setup may take a few weeks for more extensive IT landscapes and complex infrastructure.

Why should I use coordinates instead of addresses?

Geo-coordinates (latitude and longitude) are better than addresses for finding locations on a map:

• Precision: Geo-coordinates provide a much more precise location than an address that may sometimes be ambiguous or inaccurate.
• Consistency: Geo-coordinates don't change, unlike addresses (renumbering, renaming, or other changes).
• Universal: Geo-coordinates can be used anywhere in the world, whereas addresses vary greatly in format and information from one country to another.
• Technology: Geo-coordinates can be easily translated into locations on digital maps and used in GPS navigation systems, making them more versatile and convenient than addresses.

Note: Also, for addresses, we require country ISO coding.

What are components or addresses?

Addresses should contain the following information:

• Country code (mandatory)
• City
• State or province
• Postal code (ZIP Code)
• Street name
• House number

Tip: The more information, the more correct geocoding results.

Are there any other possibilities except using the API?

We only provide API access and LRI platform access as another option.

Is buffer analysis possible for a location?

In a single location scoring, a buffer around the location is not possible to analyze.

In areas and lines objects, users cannot score a point but can do it with a point buffer so that it would be a circle. It can also be adjusted with a line (complete buffer on the polygon).

Are there any API limits per day?

No. Only limits for locations number agreed in the contract and 1000 locations in per API request. Areas and lines objects are limited to a maximum size of 50.000 km² to be analyzed.