Migration tips
This topic contains tips for migrating your client applications from SOAP to REST and between REST versions.
Migrating between REST versions
Responsys REST API version changes occur only when necessary. They do not change with every Responsys product update. We aim for version changes to be backward compatible.
- Watch the What's new with the Oracle Responsys REST API topic for REST API version changes.
- We aim for version changes to be backward compatible. For most API endpoints, the version number in the path is the only change necessary. Use the Migration notes topic to learn more details about the changes (such as which API endpoints are changing) and how the changes affect your client application code, particularly the request and response payload formats.
- When a REST API version is updated, this affects the endpoint URLs used to make the API calls. To reduce impact, use a variable to represent the REST version in your client applications.
- We recommend migrating to the latest version as soon as possible. Oracle will notify customers in advance when we plan to deprecate a REST API version.
- At minimum, update your authentication API requests to use the latest REST API version. It is possible to make API requests to different API versions using the same token if you absolutely need API functionality from an earlier version. For an easier migration path later, when deprecations occur, we recommend migrating to all API requests to the latest version as soon as possible.
- Always test your client applications with the new REST API version before using in production.
Migrating from SOAP to REST
Oracle Responsys uses REST for all of its new Web Services API features. No additional features are being added to SOAP. We strongly encourage you to use the REST APIs for your client applications moving forward.
REST and SOAP are different protocols, so please plan adequate time to refactor your code if you plan to migrate entirely to REST. Oracle does not recommend using tools to wrap the REST service with SOAP-equivalent interfaces.