What is an API?
API stands for Application Program Interface. Flowcode APIs are a way for other applications (or code in other applications) to programmatically access data within your Flowcode org, in a simple and secure manner.
How do I access the developer portal?
Please go to https://developer-prod.flowcode.com. Here you will find an overview of the documentation and how to get started.
How do I register to the developer portal?
Go to the new Developer Portal (https://developer-prod.flowcode.com/)
Click "Log in" in the top right (Note: if you don't have a Flowcode account, please create an account or have an Admin invite you to your existing Flowcode org)
Log into your Flowcode account in the new tab that opens
Once you've logged in, navigate back to the Developer Portal tab you had open
In the Developer Portal tab, you should see a prompt to create an account (Note: this is a necessary step to register for the developer portal) with your email pre-populated and an input for phone number
Input your phone number and click "Create Account"
You should be redirected to the Overview page within the new Developer Portal
How do I generate my API key?
Hover on your email address in the top right of the Overview page in the Developer Portal
Click on "Dashboard" in the dropdown that appears
Click "Create API Credential"
How do I get in contact with support for API related questions / issues?
Please reach out to [email protected]
What is the Flowcode API pricing?
The Flowcode API pricing is usage-based. Please contact [email protected] to learn more.
Is there a request cap for testing via the developer portal?
The Test Tier of the developer portal is 50 requests. If you need additional requests in order to test or would like uncapped requests, please contact [email protected].
How many codes can I create with the API?
One of the main use cases of the Flowcode API is to generate Flowcodes at scale. If needed, the API has the ability to create millions of scans at a time.
What level of code designs do I have access to?
The code design customization endpoints (customization_options) are laid out in the Create Code endpoint within the documentation, which can be found here. You will have access to color, background color, center image, center image size, data pattern shape, and call-to-action text on the edge of the code.
What analytics can I access via the API?
You have access to Flowcode and Flowpage event data (scans, page views, page link clicks), as well as any contact information collected. This data can be filtered and summarized based on id, folder, time range, geographic location, and more.