Playground
The API Playground is a tool to support developers or enable non-developers to test and use our APIs.
| Contents of the Table |
|---|
Configuration
An API call can be configured and executed from within the user interface of the API Playground.
To access API Playground go to https://platform.flxone.com/api-playground
Authentication
API authentication is not needed when you are executing API calls via the API Playground since the user is already logged in and has the appropriate permissions.
Version
Specify the version for the API call. We recommend to stick to the version that is automatically populated when using an example.
Method
Specify the HTTP method for the API call.
| HTTP Verb | CRUD | Information |
|---|---|---|
| GET | Read | The GET method is used to read (or retrieve) a representation of items |
| PUT | Update/Replace | The PUT method is most-often utilized for update capabilities |
| POST | Create | The POST method is most-often utilized to create new items |
| DELETE | Delete | The DELETE method is used to delete an item identifier by a URL |
Service
Specify the service for the API call. Note that this only requires the actual endpoint, the "https://platform.flxone.com/api" part can be ignored when using the API Playground.
Parameters
Specify the key(s) and value(s) of the appropriate parameters relevent to a given service for the API call.
- Key: This form should contain the key for the parameter.
- Value: This should contain a JSON query object array and represents outline of the API call.
Examples
The API Playground includes a few examples of API configurations relevant for a specific service and task. These examples can be tweaked according to the actual use case.
| Feature | Example | Service |
|---|---|---|
| API Authentication | Authenticate to the API | auth |
| User Settings | Get an overview of all user settings | user/current |
| Data Collection | Get an overview of all pixels | tracking/beacon |
| Data Collection | Creata a data collection pixel | tracking/beacon |
| Custom Data | Get an overview of all custom attributes | external-attribute |
| Report Central | Execute a report central query | viz/data |
| Exports | Create a batch export | viz/batch-export |
Export Code
The DMP offers a couple of SDK in different programming languages to integrate our API in any environment or repository. When using the API Playground configuration the relevant API call will automatically be translated into the languages as outlined in the table below. The code can then be downloaded from within the user interface.
| Language | Library |
|---|---|
| Java | https://github.com/FlxOne/dmp-apisdk-java |
| PHP | https://github.com/FlxOne/dmp-apisdk-php |
| JavaScript | https://github.com/FlxOne/dmp-apisdk-javascript |
| C# | https://github.com/FlxOne/dmp-apisdk-csharp |
| cURL | Not recommended for production usage |
| JavaScript Vanilla | Not recommended for production usage |