REST APIs have many similarities with the widely used SOAP-based APIs supported by Address Manager. However, there are a few differences between REST interface and existing SOAP implementation:
- The names of API methods in REST remain the same as that of SOAP APIs.
- Signatures of all methods including input and output parameters in REST are the same as in SOAP.
- In REST API, various primitive request parameters such as int, long and String are expected as URL query parameters. Whereas in SOAP, all the request parameters are communicated as part of XML body.
- Complex parameter types such as APIEntity or APIDeploymentOption need to be passed as a part of HTTP body of the call in JSON format.