Quickstart

Quickstart#

Introduction#

Melissa’s Global Name Container can parse, genderize, and standardize personal names as well as able to standardize company names.

System Requirements#

  • Melissa Updater (for data files).

  • Latest Linux containerization technology (like Docker).

Getting Started#

To begin using Global Name Container, first download all required data files and spin up a container instance.

After these steps are completed, you can start sending requests to the running instance.

Download the Data Files#

Use Melissa Updater to download the data files using latest manifest called global_dq_data.

  • LINUX
.\MelissaUpdater manifest \
   -p "global_dq_data" \
   -r "latest" \
   -l "{{license_key}}"

Spin up the Container Instance#

Once the required data files have been downloaded, the next task is to set up a containerization service, like Docker, to host Global Name Container on your local machine.

It will help to have the following readily available:

  • Path to the data files

  • Desired web service listening port for the container

  • License key

Getting Credentials/Licensing#

The License Key is a software key required to use the service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team by Requesting a Demo or by calling 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key this service will not function.

Installing Docker#

Docker must be installed on your system before running any commands. Follow the instructions on Docker’s official website, then verify the installation by executing the following command.

docker --version

Logging in to Docker#

In order to download Global Name Container, log into Melissa’s container registry.

docker login hub.melissadata.net

  • Use the credentials sent by the Melissa sales team when prompted for a username and password.

Example Docker Setup#

docker pull hub.melissadata.net/melissa/global-name:latest
docker run -d --name global-name --restart unless-stopped \
           -p {{port_number}}:6245 \
           -e MD_LICENSE={{license_key}} \
           -v "{{data_path}}":/data \
           hub.melissadata.net/melissa/global-name:latest

What Can I Do?#

Once Global Name Container is set up in a Docker instance, it can be accessed like a web API using GET and POST requests.

Check the Version#

Global Name Container can provide the version number of the instance currently in use.

Endpoint#

/V3/WEB/GlobalName/GetVersion

Click here to go to the full endpoint documentation.

Try it Now#

  • GET JSON
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V3/WEB/GlobalName/GetVersion" \
-H "accept: application/json"

Check a Name#

Global Name Container can check to see if a given name is valid.

Endpoint#

/V3/WEB/GlobalName/doGlobalName

Click here to go to the full endpoint documentation.

Try it Now#

  • GET JSON
  • POST JSON
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V3/WEB/GlobalName/doGlobalName?\
&format=json\
&t=Test\
&ctry=DE\
&full=Doktor%20Enna%20Sch%C3%A4fer" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X POST \
"http://{{machine_name}}:{{port_number}}/V3/WEB/GlobalName/doGlobalName" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "Options": "",
    "Records": [
        {
            "Country": "DE",
            "FullName": "Doktor Enna Sch\u00E4fer",
            "RecordID": "1"
        }
    ],
    "TransmissionReference": "Test"
  }'
Contents