Siebel REST API Guide > Overview of Using the Siebel REST API >

About Siebel REST API Architecture

The Siebel CRM REST API services are deployed as a WAR file (siebel-rest.war) on the Siebel Java Web Container. The Java Web Container is embedded inside the Siebel CRM server. Siebel REST API requests flow through the Siebel Java Web Container. The Siebel Java Web Container routes the REST API requests to the appropriate Siebel CRM Server or Siebel Application Object Manager session.The Siebel REST Proxy Object Manger proxies for the Java Web Container, allowing management as a Siebel Component. The Java Web Container is managed by the Siebel Rest Proxy Object Manager, which uses the Server Management Infrastructure to manage the Java Web Containers. The Java Web Container hosts the Siebel CRM REST API infrastructure and provides the Siebel CRM REST API interface.

If you plan to expose access for all Siebel channels under a single Web domain, then a reverse proxy can be configured in front of both the pre-existing Siebel Web Server and the new Siebel Java Web Container. Also, if more than one Java Web Container is provisioned, then the Java Web Containers would need to be load balanced, and that can be done by configuring a Web Server with load balancing capability. For more information about reverse proxy and load balancing, see Siebel Installation Guide for the operating system you are using, Siebel Deployment Planning Guide, and Siebel System Administration Guide.

Figure 1. Siebel REST API Architecture

Figure 1 shows the high-level architecture of implementation REST support on the Siebel Server.

• Application UI Client/EAI SOAP Client. The SOAP client used to access the Siebel CRM Server.
• REST Client. The REST API client used to access the Siebel CRM Server.
• Reverse Proxy (Optional). The Siebel REST API uses a different Web server than the existing Siebel User Interface and SOAP Enterprise Application Integration channels. If you plan to expose access for all Siebel channels under a single Web domain, then a reverse proxy can be configured in front of both the pre-existing Siebel Web Server and the new Siebel Java Web Container. For more information about configuring a reverse proxy, see Configuring the Reverse Proxy
• Siebel Web Server. The existing Siebel Web Server that hosts Siebel CRM.
  • Application Object Managers. The existing object managers serving the Siebel User Interface and SOAP Enterprise Application Integration sessions.
• REST Web Server. The server that hosts the Siebel REST API.
• Server Manager. The server manager serves the Siebel REST Proxy Object Manager.
• Java Web Container. The Java Web Container routes the REST API requests to the appropriate Siebel Application Object Manager session.
  • Siebel Rest Proxy Object Manager. The Siebel Rest Proxy Object Manager is a background Siebel Server component used to manage the Java Web Container instances so that the existing Siebel Server Management Infrastructure can start, stop, and restart the instances.
  • Stateless Sessions and Connection Pooling. User Sessions are stateless and reusable. A pool of connections to the Siebel CRM server sessions are maintained by the Java Web Container. To optimize response times, session connections to the Siebel CRM server are held by the Java Web Container for a user until the Siebel Server session times out due to inactivity or is pre-empted by a request from another user when the Connection Pool reaches the maximum size configured.
  • Siebel EAI Object Manager. The Siebel Object Manager serves Siebel CRM REST API requests as well as legacy SOAP requests.