API Request Overview Parent topic

The following flowchart shows the interaction between a user and the SecureCloud server while the user attempts to obtain authentication to make API calls.
api_begin_flow_revised.jpg
The broker account information includes the set of IP addresses that will make API requests. API requests made from this IP range bypass the Incoming IP Filter. In addition, the broker account name and digest passphrase are necessary to create a digest authentication process.
The entire SecureCloud API request consists of the following parts:
  • Broker account information and the associated functions that add the information to the digest authentication process
  • Public certificate request
  • User access token request
  • SecureCloud API call
You can add all of these parts to one single file and perform the total request all at once. However, within this documentation, the total API request call is divided into three separate parts. You must call each part of the API request to bypass the Digest Authentication Filter and the User Access Token Filter. After an API request has bypassed all three filters, SecureCloud attempts to resolve the API call.
Tip
Tip
After successfully calling a SecureCloud API, do not change your digest passphrase. As long as your broker account information and your source IP address remain the same, you can continuously reuse the same functions and your user access token.