Versions Compared

Key

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

For complete ASM API documentation, follow this link: https://api-wpm. apicasystem.com/v3/Help

Supporting documentation will be referenced in the content below.

...

The base URL for all operations is https://api-wpmasm1.apicasystemapica.comio/v3/\Help

Authorization

You can authorize your requests either with either a basic authorization header or an authentication ticket parameter.

Header

Content

Example

Authorization

Basic + Base64 encoded value of string username:password
Where username is user name with access to the check and password is the user password.

dXNlcm5hbWU6cGFzc3dvcmQ=

Parameter

Content

Example

auth_ticket

Authentication ticket from API tool.

 9C94CBC4-C64E-4AEA-BBB2-8241445B06CC

API Usage Example

The following is an example of how you can use the API to trigger a check run, wait for the result and then get the result once it is available.

  1. Get the latest check results based on check ID.

https://api-wpmasm1.apicasystemapica.comio/v3/Help/Route/GET-checks-checkId-results_mostrecent_detail_level\

  1. Save

timestamp_utc

  1. Trigger a check run based on check ID:

https://api-wpmasm1.apicasystemapica.comio/v3/Help/Route/POST-checks-checkId-job\

  1. Get the latest result by continuously getting the latest result by the check-ID until

timestamp_utc has been changed.
https://api-wpmasm1.apicasystemapica.comio/v3/Help/Route/GET-checks-checkId-results_mostrecent_detail_level=1\
Note: use detail_level=1

  1. Get and save

...

  1. You can now get the detailed result for the check based on

identifier.
a. Browser:
https://api-wpmasm1.apicasystemapica.comio/v3/Help/Route/POST-checks-browser-checkId-results-urldata\
b. ProxySniffer/ZebraTester:
https://api-wpmasm1.apicasystemapica.comio/v3/Help/Route/POST-checks-proxysniffer-checkId-results-urldata\

Generate GET Calls

The API tool allows you to select a check to generate GET calls for.

...

The Check Operations Table is displayed, containing a list of calls and descriptions of each.

More information

More information about possible calls and the API can be found here: 

http://api-wpm.apicasystem.com/v3/help

Apica Synthetic Monitoring API Java Library

...