Getting documents signed, sent, and returned quickly is an essential part of running a successful business—but setting up an effective document approval workflow with an API can be tricky.
We understand that the functionality behind an API can get fairly technical. But with business benefits like creating a seamless signing experience and saving time for both teams and customers—we think everyone deserves the opportunity to disrupt their legacy approval workflows with an eSignature API, regardless of industry or technical skill level.
That’s why we’re thrilled to announce a complete revamp of all our existing API reference documentation powered by our new, feature-complete OpenAPI Spec.
You asked, we delivered
Over the past year, it’s been our mission to get to know our API customers better. As we sat in conversations with users, we noticed a theme of shared pain when learning to use our API. It was clear that we needed to give developers a more interactive and immediate way to start building, so we dug deep and built loads of new functionality to ensure a quick and delightful onboarding experience.
Explore, test, and learn all in one place
Because the new documentation is based on our OpenAPI Spec, it gets rebuilt automatically when we ship API changes. This means all that important API documentation stays in complete lockstep with our API—no more stale or missing information.
Alongside improving the quality and organization of our documentation, we’ve also added the Try it console for you to send API requests to live endpoints—so you can experiment with new configurations and get creative while you learn.
But that’s not all. We’ve also made huge new technical improvements across the board:
Goodbye static content, hello interactivity. Not sure how a parameter works? Test it out. With your Dropbox Sign API key, you can send requests directly to the Dropbox Sign API, receive real responses, and fully experience our API features without writing a single line of code.
We’ve added the highly-requested search feature that indexes our entire documentation (even nested parameters). Now you can search the entire Dropbox Sign API documentation at a granular level, so you can find the information you need in a snap.
Completely open sourced
Our OpenAPI spec is entirely open source. So when you spot a description or sample that could be better, tell us. Open an Issue in our GitHub repository and we’ll give that section some love.
A playground to discover and explore
Our Try it console lets developers, product managers, CTOs, and even non-technical users explore our live API, play around, and get creative. Want to play around with configurations, test functionality, and identify the eSignature features that deliver the most value to your users? Now you can.
With better performance, information discoverability, interactivity, and much more—these improvements mark another exciting step in the Dropbox Sign API journey—one which underscores our determination to give Dropbox Sign developers the tools they need to succeed.
A new and improved developer experience
The overhaul of our API reference documentation is just a small piece of what we have planned for this year. So stay tuned—there are a lot of exciting developments to come!
A big thanks to our API customers and developers that have provided candid feedback and supported our research throughout 2021. To the other folks we haven’t spoken with yet: we’re here, we’re listening, and we’re building for you. Give our new API reference docs a try and send us your feedback.
Check out the revamped API documentation now.