Now that the new Oneflow API is publicly available, you, as an existing customer, should be wondering if and how to start the migration process.

To make it easier for you, in this section, we'll cover the most common cases and answer the most important questions related to the transition to our new public API.

Why migrate to the public API?

Our legacy Oneflow API is good, and our clients love it. However, the new public version is even more easy-to-use, trustworthy and secure, and has a higher payload consistency. It also provides the foundation for new features, updates, and expansion proposals.

Here's the shortlist of the main benefits of the new public API:

  • New great documentation
  • Improved error handling with clear and understandable error messages
  • Clear and consistent naming convention
  • Reduced involvement of developers with customer integration
  • Fewer dependencies between development teams.

When will the legacy API retire?

We understand that this change requires effort, so we want our clients to have enough time to make the transition.

The intention to sunset the legacy API is expected towards the mid of 2022, although there's no exact date yet.

If you have any questions or concerns, please feel free to contact your customer success manager.

What will happen if I don't migrate?

As mentioned above, we will discontinue support of the legacy API. If you don't complete the migration process until the specified date, your integration will no longer function. To avoid such a scenario and ensure your integration system health, we recommend performing the migration as soon as possible.

As always, check with your customer success manager for additional support.

Authentication and security

Our existing partners and customers do not need to change their API tokens or create a new account to use our new public API.