{"id":7788,"date":"2021-04-06T20:32:08","date_gmt":"2021-04-07T00:32:08","guid":{"rendered":"https:\/\/www.redline13.com\/blog\/?p=7788"},"modified":"2023-03-29T09:27:44","modified_gmt":"2023-03-29T13:27:44","slug":"getting-started-with-the-redline13-api","status":"publish","type":"post","link":"https:\/\/www.redline13.com\/blog\/2021\/04\/getting-started-with-the-redline13-api\/","title":{"rendered":"Getting Started with the RedLine13 API"},"content":{"rendered":"

\"\"<\/strong><\/p>\n

Many users of RedLine13 are familiar with our web interface for running load tests. Yet, are you also aware that we offer a full-featured API? In this post we will walk you through how to get started with the RedLine13 API<\/a>. We will provide examples that show you how you can leverage this powerful feature to achieve new levels of automation running your load tests.<\/p>\n

Almost any task that can be accomplished using the web UI can be automated with a backend script using our API. Many of our customers create scripts using PHP, cURL, Python, PowerShell, C# and other languages. Under this paradigm, it is possible to abstract repetitive manual testing tasks. Some customers have even automated part of their testing into continuous integration pipelines and deployment architecture. (Note:<\/em> API access requires a paid plan. If you don\u2019t have a basic or premium plan, you can purchase one here<\/a>.)<\/p>\n

<\/a>Obtaining an API Key<\/strong><\/h2>\n

One of the best ways to understand our API is by example. However, before we can use the API we will need to set up an API key<\/em>. You can think of this key as a special kind of passcode that grants you access to RedLine13 resources. Below we will review step-by-step how to generate and use your API key<\/em>.<\/p>\n

<\/a>Step 1.<\/h3>\n

Navigate to https:\/\/www.redline13.com<\/a>, and log into your account as per usual. From the main menu, select \u201cAPI<\/em>\u201d, then \u201cAPI Overview<\/em>\u201d:<\/p>\n

\"Selecting
Selecting “API Overview<\/em>” from the API main menu.<\/figcaption><\/figure>\n

<\/a>Step 2.<\/h3>\n

From the \u201cAPI Overview<\/em>\u201d page, under \u201cAPI Usage<\/em>\u201d you will find a link for \u201cyour API key<\/em>\u201d. Follow this link to the \u201cAPI Key Manager<\/em>\u201d page:<\/p>\n

\"Following<\/p>\n

<\/a>Step 3.<\/h3>\n

If you have created an API key<\/em>, it will already be listed here. If that is the case, you may skip to the next step. Otherwise, under \u201cAPI Key Manager<\/em>\u201d, click on the green \u201cGenerate<\/em>\u201d button and a new API key<\/em> will be created for you:<\/p>\n

\"Generating<\/p>\n

<\/a>Step 4.<\/h3>\n

Once your API key<\/em> has been generated, it will appear for reference on the \u201cAPI Key Manager<\/em>\u201d page as follows. We will want to copy this key as it will be used later in this article when we build actual requests against the API.<\/p>\n

\"You
You “API key<\/em>” is listed under the API Key Manager.<\/figcaption><\/figure>\n

<\/a>Creating your First API Request<\/h2>\n

API Resources<\/h3>\n

Once the API key<\/em> is created as outlined above, we are now ready to build some requests. You can find a complete list of API resources on the API Documentation<\/a> page, however here is a brief overview of available operations:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Resource<\/strong><\/td>\nMethod<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
\/LoadTest<\/strong><\/td>\nGET<\/strong><\/td>\nSearch for your load tests.<\/td>\n<\/tr>\n
\/LoadTest<\/strong><\/td>\nPOST<\/strong><\/td>\nStart a new load test.<\/td>\n<\/tr>\n
\/LoadTest<\/strong><\/td>\nDELETE<\/strong><\/td>\nCancel or delete a previous test.<\/td>\n<\/tr>\n
\/StatsDownloadUrls<\/strong><\/td>\nGET<\/strong><\/td>\nGet stats download URLs for a test.<\/td>\n<\/tr>\n
\/Metrics<\/strong><\/td>\nGET<\/strong><\/td>\nAccess metric data for a test.<\/td>\n<\/tr>\n
\/Percentiles<\/strong><\/td>\nGET<\/strong><\/td>\nAccess percentiles data for a completed test.<\/td>\n<\/tr>\n
\/Errors<\/strong><\/td>\nGET<\/strong><\/td>\nGet errors for a test.<\/td>\n<\/tr>\n
\/Share<\/strong><\/td>\nPOST<\/strong><\/td>\nObtain a shareable link for a test.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

All requests share the common base URL of https:\/\/www.redline13.com\/Api<\/strong><\/span>. To construct the URL of a specific resource, we simply append the resource identifier from the above list. In the following example, we will be searching for completed load tests and as such our fully qualified URL should look like this:<\/p>\n\n\n\n
\n
 https:\/\/www.redline13.com\/Api\/LoadTest?state=completed <\/span>\n<\/strong><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Referring to the LoadTest resource documentation<\/a>, you will find a number of API parameters that may be specified. In the above URL we have set state<\/span> <\/strong>equal to \u201ccompleted<\/strong><\/span>\u201d such that only load tests which have completed running will be returned in the response. However, before we are ready to actually make this call we need to set our API key<\/em> as obtained previously. In order to do that, we will need to set this value as a request header<\/a> parameter. While in practice this can be done in any programming or scripting language, we recommend for API testing to use an API client such as Postman<\/a>.<\/p>\n
Building the Request<\/h3>\n
Since these example requests will be made against your own RedLine13 account, there is the prerequisite that you have at least one load test that you have run in order to have interesting data returned. (If you have not completed your first load test, see this post<\/a> to help you get started.) You will also have to specify your API key<\/em> that we went through the steps to obtain above. This is accomplished by setting the \u201cX-Redline-Auth<\/strong><\/span>\u201d header in the request as follows:<\/p>\n
\"Postman<\/p>\n
Keep in mind that you will be entering your own unique API key<\/em> and not exactly the one shown in this example. At this point, everything should be set up and ready for us to test. Simply click on the blue \u201cSend<\/em>\u201d button in the upper right hand corner and you should be presented with results similar to these:<\/p>\n
\"Postman<\/p>\n
<\/a>Using a Scripting Language<\/h2>\n
Postman is a great tool for getting familiar with the API as well as doing some proof of concept testing. However in real world practice, we\u2019d prefer to use a scripting language as it more easily allows us to invoke API calls based on certain triggers or events. For this example we will be demonstrating how to code this in PowerShell<\/a>, a popular and versatile scripting language for Windows systems and applicable to many cloud technologies in Azure<\/a>.<\/p>\n
The specific cmdlet<\/em> necessary to accomplish this is Invoke-WebRequest<\/strong><\/span>, with the official documentation found here<\/a> that covers it in more detail. Creating an equivalent request to the \/LoadTest<\/span> <\/strong>endpoint as described with Postman above, we can write the following code:<\/p>\n\n\n\n
\n
 Invoke-WebRequest https:\/\/www.redline13.com\/Api\/LoadTest?state=completed `<\/strong><\/span>\n  -Headers @{'X-Redline-Auth' = 'a616c98dfb43530cf218f8b3da972671'}<\/strong><\/span><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
The resultant output should closely resemble that of the Postman example above.<\/p>\n
<\/a>Troubleshooting<\/h2>\n
If you have attempted any of the above but have not been able to reproduce the output described, you may want to investigate some common pitfalls, which include:<\/p>\n