Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

CONNECT TO YOUR WORKBOOK INSTANCE

Authentication can be done in several ways using;:

  • Basic authentication (with basic you can call every request if you include the correct headers and this is only to be used if you’re running HTTPS.)

  • LDAP

  • 2Factor

ON THIS PAGE YOU WILL FIND:

Table of Contents

...

TEST WITH THE API

Below is a test was done using POSTMAN and the connection type of basic authentication. As you’ll be able to As you can see the same data that was shown within the interface is able to be retrieved out in JSON format that you can build toward.

A common practice is to use the API with is for building dashboards and data extraction points. The example below is data taken from two different areas, one is the client and some of the other data is the client responsible mixed in with a certain profile type selected (in this case it’s ID 7 which translates to “mail out”).

...

Image RemovedImage Added

...

HOW DO I FIND OUT THE CALLS NEEDED?

One way to find the needed API calls is to open up the inspecting tool within your browser, one way to do it is to press .

  • Press F12 in most browsers (this was done in

...

  • Chrome) and look for the network area

...

  • In the network area, you can refresh WorkBook on the top right and it will display all the calls that the program is using

...

...

  • An alternative way to get the console is to right-click

...

  • while having the cursor on the top bar

...

...

Filter by label (Content by label)
cqllabel = "API" and space = currentSpace ( ) and title !~ "\"api-authentication\""

...