Setup your Melissa API Key

Modified on Fri, 14 Mar at 4:25 PM

TABLE OF CONTENTS

Obtain your Melissa API Key
Setup your Melissa API Key application parameter

Obtain your Melissa API Key

To use Melissa's API with Sharp XRM, you need to get in touch Melissa's sales team.
Once you have obtained the key from Melissa, move on to the next step.
- Keep in mind, only the following Melissa APIs integrated with Dataverse :
  - Express Entry
  - Global Address
  - Personator

Setup your Melissa API Key application parameter

In the navigation bar, go to Address Validation -> Settings -> API Configuration.
Create a new record and enter the information as per your configuration.
Provide the information as follows:

Field Name	Description and Expected content
API Configuration Name	Unique name for the configuration. This will be used as an input parameter when you configure verification using Express Entry, Personator or Global.
Validation Service Type	Select the address verification API you want to use (Melissa Express Entry, Global or Personator.
Service License Key	Enter your Melissa API key (this will be provided by Melissa).
Is Valid	After the API configuration is created, click the "Validate API Key" button in the command bar. This will validate the API key to confirm the key is functional. If the API Key is invalid, you will get an error message on the screen and the value will remain No. If valid, the value will be set to Yes. [Known issue : In some cases, you might get an error message at this step. Please visit this article regarding the issue, including a workaround to continue]
Save Transaction Logs	Defaults to No. When set to Yes, anytime a call is made to a Melissa API, the details will be logged in the Logs available under the Resources area.