Waiting for engine...
Skip to main content

From manual to modern: revamping Boomi's API docs

· 4 min read
Malathi Prathivadhi
Malathi Prathivadhi
Lead, Developer Documentation @Boomi

What’s the first thing you notice when you explore a new API? For developers, it’s often the documentation—and that first impression can make or break the development experience. Clear, intuitive API documentation can mean faster onboarding, fewer integration hiccups, and smoother workflows. That’s why we’ve reimagined Boomi’s API documentation to help you build smarter, faster, and better.

As developers, we know you focus on designing APIs that excel in authentication, performance, error handling, and security. But let’s not overlook another crucial aspect; How APIs are presented and documented. Great documentation isn’t just nice to have it’s often the first touchpoint developers have with an API. And as we all know, first impressions matter.

Good API documentation does more than just list endpoints. It solves several challenges faced by developers such as:

  • Navigating complex APIs: Complex documentation impairs understanding of API capabilities and endpoints. Our revamped documentation simplifies navigation with clear descriptions and examples.

  • Reducing onboarding time: Getting started with APIs can be daunting. By providing OpenAPI specifications in Swagger format and comprehensive examples, we make onboarding quick and seamless.

  • Minimizing trial and error: Time is often wasted troubleshooting due to incomplete or unclear documentation. Our documentation reduces this friction with accurate details, request-response samples, and consistent formatting.

  • Adopting new APIs: Transitioning from deprecated APIs to new ones is often challenging. We addressed this by clearly documenting alternatives and pointing to external resources as and when needed.

That’s why we’re thrilled to introduce our newly revamped API documentation for the Enterprise Platform and Partner APIs hosted on this website (Boomi's Dev docs).

To improve your experience, we’ve included a video that walks you through exploring and using our API documentation effectively. Check it out below!

Ready to dive in? Visit our API References to explore the new documentation and check how it can simplify your development journey. Whether you need REST APIs, SOAP APIs, or guidance on deprecated APIs, we’ve got you covered!

Platform REST API reference​

The Platform REST API reference covers all you need to know about the Boomi Enterprise Platform REST APIs. You can download the OpenAPI specification directly from this page by clicking the "Download" button.

Partner REST API reference​

Partner APIs are now separated from the Platform APIs for better organization. The Platform Partner REST API reference offers flexibility for your integration needs, allowing you to download individual or combined OpenAPI specifications.

Platform SOAP API reference​

SOAP APIs are now independently documented, offering a similar experience to what was available in our help documentation but with enhanced usability. Have a glimpse of the revamped Platform SOAP API Reference.

Deprecated APIs​

While Boomi recommends using alternative APIs for deprecated counterparts, we continue to document deprecated APIs that haven’t been retired. However, some deprecated APIs are documented externally outside the specification file, with respective URLs provided for reference.

We’d love to hear from you! Your feedback is invaluable in helping us improve. Use the 'Feedback' sticky option on the API Reference pages to share your thoughts, queries or if you like to see more content on API references. Together, we can make the developer experience even better. Happy APIing!