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 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 for Microsoft Windows.

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. Install Siebel Application Interface.

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

4. Configure a Siebel Application Interface profile.

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

   For information about Siebel RESTful 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.

5. Deploy your Siebel Application Interface profile.

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

6. Determine your sizing requirements.

   Based on your sizing requirements, install and configure your application interface nodes. 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.

7. Configure business service methods for RESTful access. For more information about configuring business service methods, see Configuring Business Service Methods for RESTful Access.
8. Configure integration objects for REST API data access. For more information about configuring integration objects, see Configuring Integration Objects for REST API Data Access.