Run the REST APIs directly from the Developer Portal: use the "Try it out" button

Hi. If you want to start interacting with the Bluescape APIs, a very direct way to do that is by signing into Bluescape and then use the openapi documents in the Developer Portal, the ones in the Reference section .

Steps

  1. Log into Bluescape: https://client.apps.us.bluescape.com/my
    1.1. Your browser will store a cookie to authenticate your calls in the openapi documents in the Developer Portal
  2. Open a workspace and copy its workspace ID
    2.1. Go to the URL in your browser
    2.2. The workspace ID is the ID after “https://client.apps.us.bluescape.com/” and before “?”.
    2.3. For example, in https://client.apps.us.bluescape.com/XkV4hX_IcjCaoI1gP6s3?targetRect=%5B16943%2C4069%2C30146%2C12261%5D , the workspace ID is XkV4hX_IcjCaoI1gP6s3
  3. Create a couple of Text elements in your workspace
  4. In the same browser, open a new tab and load the Developer Portal Reference page: https://api.apps.us.bluescape.com/docs/page/reference
  5. Select one of the openapi documents under REST API v3 and use the Try it out button on the path of each API.

Example

As example, let’s examine the content of the workspace:
a) Click on the “Workspace Content APIs” link
b) Select Elements > Get (https://api.apps.us.bluescape.com/docs/doc/us/elementary#/Elements/RestQueryController.find)
c) Click the “Try it out”

d) You will see that the fields are enabled for edition now
d.1) In the workspace field, paste the workspace ID
d.2) In the Type field, select Text
d.3) Delete the sample values in the rest of the fields
d.4) Example:

e) Click the Execute button
f) You will see the results are below the Execute button, in the Responses section:
f.1) Curl: this is the curl operation you could run to execute this API
f.2) Request URL: this the request URL that was executed. You can use it in Postman or other similar tool.
f.3) Response Body: These are the results of the execution of your API, all the Text elements for the specified workspace

These are the results:

You can repeat the same steps (c to f) with other API paths.
After clicking the Try it out button, remember to delete the default values you do not want to use, or they will be included in the API execution.

3 Likes