Customer Profile API

The Customer Profile API provides information about the custom campaigns set up for any of your experiences. This means it helps collect more information about your guests from an external form, outside AnyRoad.

To make requests for our API, you will need an API key. Your AnyRoad user id and password are your normal AnyRoad account login credentials. Once you receive your API key, you will be able to make requests to all endpoints. Please keep your API key secure. If you believe your key has been compromised, please contact us for a new one.

All responses adhere to the JSON:API formatting guidelines found here: JSON API — A specification for building APIs in JSON.

Requesting an API Key

Please reach out to your AnyRoad Account Manager to activate your API key. Once activated, send the below request to receive your API key. You will need the AnyRoad account registered email and password associated with the owner of the account.

Request:

curl https://app.anyguide.com/external/api/v1/users/key -u
"janedoe@example.com:SuperSecretPa$word"<br>

Response:

Status: 200

{ "data": { "type": "users", "id": "123", "attributes": { "key": "example-key-1234" } } } jvhjhkjhkjhkjhkljhkl

API Key Verification

To verify that your API key is active, send the following request, where <API KEY> is your API key:

Request:

curl -H 'X-API-KEY: '
https://app.anyguide.com/external/api/v1/users/profile

Response:

Status: 200

{
"data": {
"type": "users",
"id": "123",
"attributes": {
"first_name": "Jane",
"last_name": "Doe",
"email": "janedoe@example.com"
}
}
}

Key Terminology

Customer Profile

The CustomerProfile API allows partners to append additional data to a customer’s AnyRoad profile. Its flexible structure can absorb just about any data type - customer preferences, demographics, psychographics, segmentation - that can then be viewed on a customer profile within AnyRoad, and used for analytics.

Campaigns

Campaigns define the data structure for a CustomerProfile update. Each Customer Profile update is connected to a single campaign. A campaign has the following important information:

Name - a name to help easily identify the campaign
Data model - this is used to validate the data_set that you will be passing to the UPDATE endpoint (more about this below in the JSON Structure section)
Display label - the partner or customer facing label associated with the data
Display key - this is the value key that will be needed to be passed in the data_set, the value of which will be displayed under the display label heading
Approved IPs - this is a list of IP addresses that are authorized to use this API

JSON Structure

When sending a JSON object to update the data set, the structure of the JSON must match the predefined structure contained in the data model attribute of the campaign. AnyRoad will help to create this structure when the campaign is created. For this API, we conform to JSON Schema Draft 4. The JSON schema description is quite extensive (see: Understanding JSON Schema — Understanding JSON Schema 7.0 documentation) but the following small example may help to get started:

{
"type": "object", <- type of the Schema. This will always be "object"
"required": [ <- list of required properties
"flavor_profile" <- the only required property in this example],
"properties": { <- more detail about the properties
"flavor_profile": { <- this matches the property above
"type": "string" <- the type of the property}
},
"additionalProperties": false <- indicates that no properties other than
} the ones listed above are allowed

Here are few valid & invalid JSON objects following the above schema:

{ "flavor_profile": "red" } VALID
{ "flavor_profile": 6 } INVALID - wrong type
{ "flavour_profile": "red" } INVALID - mismatched property name
{ "flavor_profile": "red", "hacky": "hack" } INVALID - extra property

Endpoints