Flxpoint

Flxpoint API

The below configuration is based on Integrating as a Channel's Simple Connection endpoints provided by Flxpoint. If an alternate integration into Panoply is desired, please reach out to our Support Team and we would be happy to assist in setting up that connection.

Configuration Parameters

Any instance where an entry in the below configuration has a leading $ represents a parameter that needs to be replaced with a static value.

Parameters in this document:

$access_token - The Access Token will provide access to the Flxpoint API. For details on creating an access token, see the Generating an Access Token for Channel section found here.
$resource_name - The Resource Name represents the name of the resource to be appended and used as part of the Destination Table name. The value that should be used here can be found in the API Resources table below.
$endpoint - The Endpoint represents the data that you would like to ingest into Panoply from the Flxpoint API. The value of this parameter can be found in the API Resources section below.
$page_size - The Page Size value represents the number of records returned by the API per page. The value of this parameter can be found in the API Resources section below.
$incremental_starting_value - The Incremental Starting Value represents the earliest date that data should be collected for, given in yyyy-mm-DDT00:00:00Z format. For example, if you would like your historical data to go back to the start of 2021, this value would be set to 2021-01-01T00:00:00Z.

API Resources

For a list of API Resources available for Flxpoint, please refer to the list of endpoints found below:

Resource	$resource_name	$endpoint	$page_size
Listing Parents	listing_parents	listing/parents	50
Listing Variants	listing_variants	listing/variants	100

Connector configuration

Base url: https://api.flxpoint.com/$endpoint
Method: GET
URL Parameters: pageSize=$page_size

In addition to page_size, the below URL Parameter should be included depending on the endpoint you are using. This will be required for incremental collections, and therefore must be included.

Listing Parents: updatedAfter={incval}
Listing Variants: basicsUpdatedAfter={incval}

Additional URL Parameters

Additional URL Parameters can be provided as part of the URL Parameters entry to further specify the API call and impact the response that is ultimately ingested into Panoply.

Additional URL Parameters that are available will vary with each Resource, and can be found under the Query Parameters section of each Resource's page that is linked in the above API Resources table. Each Additional URL Parameter should be appended using a & separator, such as pageSize=100&basicsUpdatedAfter={incval}.

Headers: {"Accept":"application/json"}

Destination Table naming convention is ultimately up to you as the data owner. One common structure used for this API is flxpoint_$resource_name

Authorization

Authorization: API Key
Key: X-API-TOKEN
Value: $access_token
Add to: Headers

Pagination

Enable:
Get next page value: Static (integer to be incremented)
Start page: 1
Page step: 1
Use next page value: As a URL parameter value
URL/body key: page
Stop iterating when: Empty data

Advanced Settings

Incremental Key:
Column name Column value
updatedAt $incremental_starting_value