About Setting Up the Siebel CRM REST API

The Siebel REST API is implemented as part of the Siebel Application Interface installation. You must create and deploy a Siebel Application Interface profile before using REST related components on the Siebel server. For more information about Siebel Application Interface, see Siebel Installation Guide.

Before you begin using the Siebel CRM REST API, you must perform the tasks described in this topic. Many of these tasks are described in Siebel Deployment Planning Guide.

1. Review all documented hardware and software requirements.

   For more information, see the Certifications tab on My Oracle Support.

2. The latest version of Siebel Enterprise Server software must be installed.

   For more information about performing a new Siebel Enterprise Server software installation, see Siebel Installation Guide.

3. Install Siebel Application Interface.

   For more information about installing Siebel Application Interface, see Siebel Installation Guide.

4. (Optional) Configure preprocessing and postprocessing steps for inbound REST API. For more information, see Configuring Preprocessing and Postprocessing Steps in Inbound REST API.

5. Configure a Siebel Application Interface profile.

   For more information about configuring a Siebel Application Interface profile, see Siebel Installation Guide.

   For information about Siebel REST API configuration parameters that must be configured when you create the Siebel Application Interface Profile, see Using Siebel Management Console to Configure a Siebel Application Interface Profile.

6. Deploy your Siebel Application Interface profile.

   For more information about deploying a Siebel Application Interface profile, see Siebel Installation Guide.

7. Determine your sizing requirements.

   Based on your sizing requirements, install and configure your application interface nodes. It is recommended that you perform load balancing to distribute complex tasks among multiple Java Web Containers. For more information about load balancing, see Siebel Installation Guide .

8. Configure Business Service methods for REST access. For more information about configuring Business Service methods, see Configuring Business Service Methods for REST Access.

9. Configure integration objects for REST API data access. For more information about configuring integration objects, see Configuring Integration Objects for REST API Data Access.