The Request Editor lets you execute HTTP requests from your browser. Requests are stored in the current bucket and the URLs you enter are automatically converted to Gateway URLs. Once a request is executed you can share, star or edit & retry the request directly from the editor.
The Request Editor does not follow redirects by default. If you make a request to a URL that returns a 3xx response code, you will see this in the response.
To automatically follow redirects, set 'Follow Redirects' to 'On'. When a redirect response is encountered the editor will make a subsequent request to the URL indicated by the response. Once a non-3xx response is encountered the final response will be displayed along with a list of each of the redirects encountered along the way.
To use an existing request as a starting point for a new request, click the edit icon for any request in a stream view. This will pre-load the request data from the previous request into the editor. When the edited request completes you can share it like any other request, or compare it to the original request used as the starting point.
Note: some header values will be automatically set from the data in the new request (like the hostname) but you can override these values by specifying them directly.
The editor supports a few options to help make authenticating requests easier. If the API you are calling requires HTTP Basic authentication, enter the username and password required. The editor will automatically create the necessary
Authorization header value.
If the API you are calling requires OAuth 1.0a, enter the key, token and secrets generated from the authorization flow. Some APIs (like Twitter) generate these tokens for you in their developer portal, otherwise you'll need to obtain them by setting up the necessary web endpoints. At present, the editor only supports generating HMAC-SHA1 signatures.
For OAuth 2.0, use the Runscope OAuth Tool to generate the necessary
Once you have generated a token, add it to the request as a URL parameter or HTTP header value as indicated by the API provider.
For all other authentication schemes, add the required HTTP header or URL parameter as indicated by the API provider.
If the current bucket uses authentication the required header value will be automatically pre-populated with the auth token.
After a request is completed and the result is shown the request and response bodies will be indented and colorized. To see the raw data, click 'View Raw'. Note that if the response was compressed that the raw view will show the content post-decompression.
We currently only support text-based responses (JSON, XML, HTML, etc). Other response types will display the base64-encoded bytestream.
You can create a link to the Request Editor that pre-populates the fields from values specified in URL parameters.
Supported fields and parameters:
|Field||URL Parameter||Accepted Values|
|Method||method||One of the following values: GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE.|
|URL||url||Any valid URL.|
|HTTP Basic Username||username||A string.|
|HTTP Basic Password||password||A string.|
A JSON object of name/value attribute pairs. The attribute name is used for the header name. The attribute value should be an array of values. If you need to specify multiple headers with the same name but different values, specify the name once and pass the values into the array.
A JSON object of name/value attribute pairs. The attribute name is used for the parameter name. The attribute value should be an array of values. If you need to specify multiple parameters with the same name but different values, specify the name once and pass the values into the array. Only used if method specified is POST, PUT, PATCH or DELETE.
A JSON object of name/value attribute pairs. The attribute name is used for the parameter name. The attribute value should be an array of values. If you need to specify multiple parameters with the same name but different values, specify the name once and pass the values into the array. Only used if method specified is GET, HEAD or OPTIONS.
|Request Body||body||A string.|
|OAuth 1.0a Consumer Key||consumer_key||A string.|
|OAuth 1.0a Consumer Secret||consumer_secret||A string.|
|OAuth 1.0a Access Token||access_token||A string.|
|OAuth 1.0a Token Secret||token_secret||A string.|
|Digest Username||digest_username||A string.|
|Digest Password||digest_password||A string.|