Suggest API

Comprehensive documentation for integrating Cercalia’s Suggest API into your applications.

Web Services

Documentation about the Suggest functionality available through the HTTP-JSON web service of the CERCALIA platform.

Request Methods
  • GET: Parameters are sent in the URL.
  • POST: Parameters are sent in the body of the request.
Response Format
  • Responses are returned in JSON format.

Introduction to the Cercalia Suggest API

The Suggest web service provides functionality for querying addresses, localities, and points of interest. This service allows you to:

  • Suggestion Requests:

    • Includes addresses, localities, and points of interest (POIs).
    • Does not include precise coordinates for addresses. A subsequent geocoding request is required to obtain detailed address coordinates.
  • Geocoding Requests:

    • Retrieve the X and Y (longitude and latitude) coordinates of a specific address.

Key Details

  • Suggestion requests already include the coordinates for each candidate, except for addresses, which only return the default street coordinate.
  • For detailed portal coordinates, an additional geocoding request to the web service is required.

Web Service URL

https://lb.cercalia.com/suggest/SuggestServlet?


Suggest Requests

Comprehensive documentation for integrating Cercalia’s Suggest API into your applications.

Geocoding Address Requests

Detailed documentation on how to perform geocoding address requests using Cercalia’s Suggest API.

POI Requests

Detailed documentation on how to perform POI suggestion requests using Cercalia’s Suggest API.

Bracket locality

Explanation on how to use brackets in the “t” parameter to differentiate the locality when searching with Cercalia’s Suggest API.

Examples requests

Detailed and explained requests

Languages

Suggest languages

Errors

Detailed documentation when error is returned

Last modified December 16, 2024: feat: docs + jenkins ci (e06656a)