Start using the SOAP APIs
The SOAP API is no longer available for new clients. Use our REST API instead. If your application is currently making requests to the SOAP API, you need to migrate to the REST API as soon as possible. We will shut down the API on April 1, 2022, at the latest.
Before integrating our SOAP APIs, read through the following information to help you get started:
The following are the schema definitions for our SOAP APIs:
The following describes the status codes that result from successful and unsuccessful calls to our SOAP APIs:
If your company uses SOAP, then the process for error detection is different than under REST. Under SOAP, only two HTTP Status Codes are returned.
- Codes in the 2xx range indicate that the function call was successful.
- Codes in the 5xx range indicate an error on the cleverbridge side.
|200||Request did not fail due to server error.|
|500||Request failed due to server error.|
Upon calling an API endpoint, check the HTTP header status code.
- If the status code is 500, then the call failed due to a server error.
- In case of a non-500 status code, search the XML body for a fault node. If a fault node is found, then the call failed. Evaluate the following fault subnodes:
faultcode: Provides information on the type of error that occurred.
faultstring: Contains the error message to aid in handling the error appropriately.
If a fault node is not found, then the call was successful.
To guarantee a stable and reliable performance of our platform, cleverbridge places limits on the amount of data that can be consumed. API users are limited to a maximum of 150 requests per second from an IP address or range. All API requests count towards the rate limit.
When an individual IPv4 address or IPv6/64 IP range exceeds the per-second request limit, further requests to our API are blocked with an HTTP 429 status code until the block time has expired. This happens after one minute. The HTTP response contains a
Retry-After header to indicate when you can resume sending requests.
HTTP/1.1 429 Too Many Requests Content-Type: text/html Retry-After: 60
The most likely cause of an
HTTP 429 Too Many Requests error is that you perform a batch operation that sends multiple API requests in parallel. To avoid reaching the rate limit with batch operations, observe the following best practices:
- Send API requests in serial and not in parallel, that is the next call included in the batch operation cannot be made until the current call is completed.
- Limit concurrent threads that make requests (across all processes and machines) to a maximum of four.
The use cases for the SOAP APIs are similar to the back-end REST APIs. For more information, see Start using the Back-End REST APIs.