Get started

To get started, you’ll need API keys that you can request from your customer success manager. API keys are issued for every unique account including optional sub-accounts, if you wish to segregate data and/or access.

Identifier/API keyDescription
X-Frankie-CustomerIDUnique identifier for your account
X-Frankie-CustomerChildIDUnique identifier for your sub account
api_keyPrivate key for authentication

There are two different API keys for each account, one for each FrankieOne environment.

UATTest your credentials and build out your app with realistic test data
ProductionLaunch your application with real data

Once you have obtained your API credentials, you can proceed with the following use cases: