API Overview

Fanplayr 360 provide many integrations to get data into our system, but if you need to get data from an application we do not yet support, such as a phone app or custom CRM, we have options for that too.

Events

Events are the main way you will get data into Fanplayr 360. These consist of an event name, and key/value pairs of Attributes.

In general the Attributes will be scalar values such as a number or string, but when used with Semantic Objects may be more complex.

An example to say that a user was shown a surprise product (it's a wizards store!) would look like this (using the JavaScript API):

// any string can be used as the event name
fp360.track('Suprise Product', {
  // a custom attribute
  websiteSection: 'wizard-shop',
  // a semantic attribute and object
  $product: {
    id: 'BF203',
    name: 'Beautiful Training Staff #1',
    price: 12.99,
    currency: 'EUR'
  }
})

Other Interactions

The other interactions you may use are:

  • Add identifying information to a user. For example "This user is identified by an email address user@domain.com". If you identify a user again with the same email address Fanplayr 360 will merge the Profiles and Events for this user.

  • Set consent for a user. For example "This user has consented to be contacted by phone, on the number 555-555-5555 for the purposes of marketing".

JavaScript API

The easiest way to get data into our system is using our JavaScript API. We have a library that handles all the complexities for you so you can simply add fp360.track('EVENT', { data }) to your website to get started.

Shopping Carts

Even easier we have pre-built integration instructions that use the JavaScript API under the hood.

Custom API

To send Events and set Profile attributes into Fanplayr 360 we already provide a JavaScript API, but you can may want to get data into Fanplayr 360 from a service we don't yet support such as your phone app.

To do this all you need is a WRITE_KEY and ENDPOINT which you can get by creating a Custom integration.

You can then create a POST to the ENDPOINT. Easy (for your developer).

Semantic Data

If you use the JavaScript API or write your own Custom API it is good to know about Semantic Data to get the most out of the system.

Last updated