At Runscope, we don’t just love helping developers solve API problems—we’re passionate about APIs across the board. We built Runscope so that you can test any API, from REST to SOAP to everything in between, successfully. Internally, we rely on more than 60 APIs and microservices to power our infrastructure. It’s with that passion that we’ve been working on some major additions to the Runscope API in response to the valuable feedback that you’ve provided about how you want to use Runscope in your organizations.
Today we’re excited to announce the official release of the newly improved and updated Runscope API. This update allows you to fully integrate Runscope into your workflow, and manage tests, environments and schedules programmatically.
The Runscope API is available to all Runscope customers, and you can access your API keys in your Runscope profile under Applications. The updated API gives you the power of Runscope at your fingertips, providing you with complete control over API test automation and management.
Building a Better Runscope with Your Feedback
We’ve had the Runscope API available to customers since we launched Runscope in 2013, and Runscope has come a long way since then. The original Runscope API was read-only and built as a way to upload custom recorded traffic, and gather test result data and information about your teams, which served the Runscope product well at the time.
However, today’s Runscope looks much different than it did two years ago: You can now reuse API tests across multiple environments, test APIs from locations around the world, import tests from Swagger definitions, run browser tests in parallel, integrate with Slack and Datadog, plus so much more. We wanted our API to be just as robust, if not more so, than Runscope itself.
Our focus has always been on the feedback you’ve given us that relates to your most pressing needs. For the most part, these requests have included tooling around novel and advanced configurations, as well as broader monitoring and testing capabilities across locations and environments. With these cornerstone features in place, we've been able to round out the Runscope API’s functionality after months of work and testing behind the scenes to provide you with a fuller, richer API that powerfully extends your ability to use Runscope across any use case in parity with the web interface.
What’s New: Test Automation and Management at Your Fingertips
The Runscope API has been updated to include nearly every capability you have in the Runscope UI, plus several major new features to help you work quickly across teams with less hassle. The API is RESTful and communicates with JSON-formatted data. By leveraging the updated Runscope API, you can mold Runscope to your unique needs without having to traverse the UI, along with the following key additional features:
Automate: Streamline operations and save hours of work by programmatically creating and auto-generating complex tests across multiple APIs and services.
Write in bulk: Solve large-scale test management pains with the ability to create and delete multiple tests at the same time. You can also leverage the search and replace function to find and remove pieces of a test fast.
Import: Save hours of work you’ve already done building API definitions with schemas like Swagger and instantly turn them into Runscope tests.
Modify: In one easy step, modify entire tests, environments and schedules faster than ever.
Streamline: Build advanced tests with ease by adding condition steps, pauses and integrations with browser tests in Ghost Inspector.
Integrate with CI and CD: Connect Runscope tests and schedules seamlessly into your continuous integration (CI) and continuous deployment (CD) processes. Implement chained requests and trigger URLs so that your CI process not only kicks off a test, but also updates the test before it begins.
Store: Protect your work by backing up your data and storing it through the API.
Check out the Runscope API docs to learn how you can implement all of the above functionality in your organization. If you are already familiar with Runscope, then the docs will be a breeze to look through.
Sample Apps and More to Get You Started
In our API sample app repo, there are two Python apps we’ve built off the Runscope API that you can use immediately that showcase the simplicity of writing and backing up tests. We've also created an API Explorer in which you can tinker and make live API calls instantly. We’ll continue to add more apps for you, and we encourage you to build your own and tell us about it!
1. Create Tests
We’ve made building new API tests a snap via the updated Runscope API. With this app, you can learn how to create tests programmatically without having to go into the Runscope Dashboard UI. This app has a couple of sample tests in JSON that you can import directly into your Runscope account to run immediately.
2. Backup Tests
You’ve spent the time and effort creating robust tests for the variety of use cases and APIs in your stack—wouldn’t it be great if you could download and back them up? With the new Tests resource, you can fetch test configurations and store them outside of Runscope itself. This functionality gives you more flexibility for managing your tests.
This app traverses all of your buckets, fetches every test and saves them in time-stamped buckets. Take a snapshot of a representation of your tests for backup and versioning, and use the Runscope API to POST a copy to a new test, or PUT an update over an existing test.
If you’re the hands-on type of developer who likes to tinker and read the docs later, try out the Runscope API Explorer. Traverse through the resources and methods, and when you’re ready, just go through the OAuth flow and start making live API calls.
NOTE: There are several API methods that can overwrite and delete your existing test configurations. We highly recommend that you use a sandbox account or create a sandbox bucket while you’re learning to use the API and building/testing apps. In fact, maybe it’s a good time to use the sample app above and backup all of your test and environment configuration data!
Take It for a Spin
We are committed to producing more sample apps that showcase the power of the Runscope API, and we want to see what you build with it too! The Runscope API is available to anyone who uses Runscope, and you can sign up for free in just a few seconds. Did you build a cool tool that you’d like to share with the Runscope community? Tell us about it in the comments below so we can showcase it on the blog, or add to our GitHub repo of examples.