Getting started
The documentation is meant to be used alongside our swagger documentation, accessible through any of our sites appended with ‘/flow’ While we do mention the most common scenarios, a complete list of our API and example values can be found there.
Endpoint URL
The base URL for the API and a list of all the endpoint URLs for different operations.
Request/Response formats
A description of the request format (e.g., JSON, XML), including required fields and data types. Information on the response format and possible status codes.
Authentication
- Oauth 2.0
- Header authentication (token in header)
- Possible to:
- Login as user with username and password
- Can be useful if one need a user to login to Core
- Login as system user with client identifier and client secret
- For each Core/Flow instance there will be created a unique client credential for each integrator
- Login as user with username and password
Error handling
Explanation of error codes and messages that the API may return, and how the integrator should handle them.
Sample code
Code samples in different programming languages demonstrating how to use the API, making it easier for the integrator to get started.
Best practices
Recommendations on how to use the API efficiently and avoid common pitfalls.
Versioning
Information on how to manage changes to the API over time and how to migrate to a newer version.