Step 1: Confirm Oracle CPQ Cloud Service Version

Contact your Oracle CPQ Cloud Service system administrator to confirm that your Oracle CPQ Cloud Service implementation is on version 2015 R1 or later. If you need to interact with the Document Designer and Email Designer REST resources, Oracle CPQ Cloud Service must be on 2015 R2 or later.

If your Oracle CPQ Cloud Service implementation is on a version older than 2015 R1, you must upgrade in order to begin working with the Oracle CPQ Cloud Service REST API.

Step 2: Obtain User Credentials

Contact your system administrator to obtain Oracle CPQ Cloud Service user credentials for calling the Oracle CPQ Cloud Service REST API.

The Oracle CPQ Cloud Service user you are given credentials for will determine which REST resources you have access to and what actions you can perform through REST calls.

See Authentication for more information.

Step 3: Choose a REST Tool

You can access the Oracle CPQ Cloud Service REST API from any application or programming platform that can transfer data with the Hypertext Transfer Protocol Secure (HTTPS) and has access to the internet. For example:

• cURL is an open source, command-line tool for transferring data with URL syntax via various protocols, including HTTPS. See Use cURL for more information on installing cURL and using it to call Oracle CPQ Cloud Service REST resources.
• Certain web browsers can also be used to send REST API calls. Support varies across vendors, and browser plugins/extensions may be needed for full support.
• Many programming platforms (Java, Ruby, Perl, PHP, .NET, etc.) can also send REST API calls, although some may require the use of third party libraries for full support. See your programming platform's documentation for guidance.

Install cURL or establish another third party tool or programming platform to send REST API calls from so that you can begin sending requests to the Oracle CPQ Cloud Service REST API.