Siebel REST API Guide > Getting Started with the Siebel REST API >

About Setting Up the Siebel CRM REST API

The Siebel REST API is implemented as part of the existing EAI component group, so enabling the EAI component group will enable the REST related components on the Siebel server. For more information about enabling component groups, see System Administration 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 the 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 the Siebel Installation Guide for the operating system you are using.

3. Use the Siebel Server Configuration Wizard to set the Anonymous User Login Name and Anonymous User Password Siebel RESTful Server Settings. These settings are for passwords that will be used to login to the Siebel Server when no credentials are passed through the REST API request. For more information about the Anonymous User Login Name and Anonymous User Password Siebel RESTful Server Settings, see Configuring the Siebel Java Web Container.
4. Determine your sizing requirements.

   If more than one Java Web Container is required for your Siebel REST deployment, the DfltTasks parameter must be configured on the Siebel Rest Proxy Object Manager Component. By default, the DfltTasks parameter value of 1. For more information about configuring load balancing, see Configuring the worker.properties File for Load Balancing.

   Oracle recommends load balancing to distribute complex tasks among multiple Java Web Containers. For more information about load balancing, see Siebel Deployment Planning Guide.

5. Configure a reverse proxy.

   If other Siebel access channels such as User Interface Applications and SOAP Enterprise Application Integration need to be accessed through the same domain as the Siebel REST API, a reverse proxy must be configured to for the Siebel Web Server and the Java Web Container and present a unified domain for external clients to request.

   For more information about configuring a reverse proxy, see Configuring the Reverse Proxy.

6. Configure business service methods for RESTful access. For more information about configuring business service methods, see Configuring Business Service Methods for RESTful Access.
7. Configure integration objects for REST API data access. For more information about configuring integration objects, see Configuring Integration Objects for REST API Data Access.
8. Configure a Java subsystem for REST API repository access and enable the EAI component group. For more information about configuring a Java subsystem and enabling the EAI component group, see Enabling REST Services.