Getting Started with the REST API - geo_addressing_sdk

Getting Started with the REST API - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type

Software

Portfolio

Locate

Product family

Geo Addressing

Product

Geo Addressing SDK

Version

5.0

Language

English

Product name

Geo Addressing SDK

Title

Geo Addressing SDK Developer Guide

2023

First publish date

2007

Last updated

2024-11-14

Published on

2024-11-14T12:57:29.533342

Get to know about REST APIs.

Requirements

Geo Addressing SDK (GA SDK) distribution (ggs-dist-{version}.zip)
- Once unzipped, you'll need the GGS SDK CLI located in "{directory}/ggs-dist-{version}/cli"
Dataset(s) in the Spectrum data format (*.spd)
For additional detail, see System Requirements.

Placeholders

The following conventions are used as placeholders for some common items:

{directory} Any directory where you would like to install the resources for the SDK.
{version} The version of the GGS SDK such as 3.0.0.
{spd} Dataset in the Spectrum data format. For example, KGD082019.spd.
{tomcat} - installed Tomcat location. For example, apache-tomcat-8.5.30.

Configure using the GGS CLI

Create a location where datasets will be installed.
1. Windows:
```
mkdir {directory}/data
```
2. Linux:
```
mkdir-p {directory}/data
```
Run the GGS CLI. The command below starts the CLI in autocomplete mode.
Note: The GGS CLI can be run in autocomplete or batch mode. [About the CLI Batch Process.]
1. Windows:
```
cd {directory}/ggs-dist-{version}/clicli.cmd
```
2. Linux:
```
cd {directory}/ggs-dist-{version}/cli
cli.sh
```
Locate .spd file(s) and extract the dataset(s). [About the Extract command.]
```
extract --s "{spd}" --d "{directory}/data"
```
Configure data for the SDK, based on the dataset location, by running this command from within the autocomplete CLI. [About the Configure command.]
```
configure --s "{directory}/data" --d "{directory}/ggs-dist-{version}/resources/config"
```

Deploy REST API to Tomcat

Note: The {tomcat}/webapps/Geocode directory must be empty before proceeding with this command. [About the Deploy command.]

deploy  --c  "/ggs-dist-{version}/resources"  --m  "WAR_EXTRACTED"  --d  "{tomcat}/webapps/Geocode"  --l "{tomcat}/logs"

Start the Server

From the tomcat directory cd {tomcat}/bin
1. Windows:
```
startup.bat
```
2. Linux:
```
./startup.sh
```

Sample Application

As you explore the REST services, you may find it helpful to use the Geo Addressing SDK Sample. This is an autocomplete web application that demonstrates service requests and responses. The URL is relative to any context of the server, depending on where the war is deployed. URL: http://{server}:{port}/{:context}/sample/index.html

For example, to see typeahead functionality, click Geocoding Services > Address Autocomplete in the sample application.