Everything WB is covering pretty much, but then also would like to add some general info about authenticating also and how the API user relates back to user permissions in the UI (Client, Company and module access permissions) - see separate articles.
...
ON THIS PAGE YOU WILL FIND:
...
| Table of Contents |
|---|
HEADER
Text 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
See further information on Authentication in Postman
| Button macro | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ON THIS PAGE YOU WILL FIND: | |
|---|---|
|
...
TEST THE API
Below is a test was done using POSTMAN and the connection type of basic authentication. 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 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”).
...
HOW DO I FIND THE CALLS NEEDED?
Postman
You can find the official Postman collection, including documentation in Postman
| Button macro | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
WorkBook API docs
You can find every available API endpoint within WorkBook by navigating to the following URL:
http://{base url}.workbook.net/api/metadata
Browser Developer Tools
One way to find the needed API calls is to open up the inspecting tool within your browser. In this view, you can watch every API call being made in the application, as well as sent and response data.
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
For macOS, to open this window, go to View → Developer → Inspect Element
(macOS shortcut : option + command + I )
...
Related articles
| Filter by label (Content by label) | ||
|---|---|---|
|
...