|
Siebel REST API Guide > Getting Started with the Siebel REST API >
Using Siebel Management Console to Configure a Siebel Application Interface Profile
After the Siebel Application Interface is installed, you must use the Siebel Management Console to create a Siebel Application Interface profile before using Siebel RESTful services. For more information about creating a Siebel Application Interface Profile, see Siebel Installation Guide for Microsoft Windows. This topic includes the Siebel RESTful configuration parameters that must be configured when you create the Siebel Application Interface Profile. This topic includes the following:
Configuring REST Inbound Authentication Parameters
You can configure resource parameters by giving the parameters alternative query names. Table 9 contains the REST inbound authentication parameters that you configure when you create a Siebel Application Interface Profile. For more information about configuring a Siebel Application Interface profile, see Siebel Installation Guide for Microsoft Windows.
Table 9. REST Inbound Authentication Configuration Settings
Siebel Management Console Parameter |
|
|
Anonymous User Name |
Authentication > REST Inbound Authentication |
Specify the anonymous user to use for anonymous REST inbound requests. |
Anonymous User Password |
Authentication > REST Inbound Authentication |
Specify the password for the anonymous user for REST inbound requests. |
Authentication Type |
Authentication > REST Inbound Authentication |
Specify the authentication type that the Siebel Application Interface nodes accept for REST inbound authentication. You can select one of the following options:
- Basic Authentication
- Single Sign-On
- OAuth
|
Trust Token |
Authentication > REST Inbound Authentication |
This option appears if you select the Single Sign-On or OAuth option. Specify the trust token to use for REST inbound authentication |
Authentication URL |
Authentication > REST Inbound Authentication |
This option appears if you select the OAuth option. Specify the URL to use for REST inbound authentication. |
User Specification |
Authentication > REST Inbound Authentication |
This option appears if you select the Single Sign-On option. Specify the user specification to use for REST inbound authentication. |
Session Timeout (seconds) |
Authentication > REST Inbound Authentication |
Specify the session timeout, in seconds, to use for REST inbound authentication. This is the timeout which a connection will be kept open for further requests from same user. |
Secure Channel |
Authentication > REST Inbound Authentication. |
This option applies only for the OAuth authentication type as follows:
- Select this check box only when you have already imported the Authentication URLfs CA certificate into the Application Interface truststore.
- Deselect this check box when the Authentication URLfs CA certificate is not available in the Application Interface truststore.
In this case, the Application Interface trusts all certificates while calling the Authentication URL over HTTPS. |
Configuring REST Inbound Default Parameters
Table 10 contains the REST inbound default parameters that you configure when you create a Siebel Application Interface Profile. For more information about configuring a Siebel Application Interface profile, see Siebel Installation Guide for Microsoft Windows.
Table 10. REST Inbound Default Configuration Settings
Siebel Management Console Parameter |
|
|
Object Manager |
REST Inbound Defaults |
Select the Object Manager component to use for REST inbound communications, such as EAI Object Manager. |
REST Response Base URL |
REST Inbound Defaults |
Specify the base URL used to generate URLs for resources in REST responses. |
Maximum Possible Connections |
REST Inbound Defaults |
Specify the maximum number of possible connections available to serve REST requests. Default value: 20. |
Minimum Connections in Pool Size (%) |
REST Inbound Defaults |
Specify the minimum number of connections in the pool available to serve REST requests, as a percentage of the maximum. Default value: 25. |
Configuring REST Resource Parameters
Table 11 contains the REST resource parameters that you configure when you create a Siebel Application Interface Profile. For more information about configuring a Siebel Application Interface profile, see Siebel Installation Guide for Microsoft Windows.
Table 11. REST Resource Parameter Configuration Settings
Siebel Management Console Parameter |
|
|
Method Name |
REST Inbound Defaults / REST Resource Parameter List > Query. |
Specify the method name to use for queries. |
Name |
REST Inbound Defaults / REST Resource Parameter List > Query > Parameter List. |
Specify the name for each query parameter. |
Alias |
REST Inbound Defaults / REST Resource Parameter List > Query > Parameter List |
Specify the alias for each query parameter in the REST resource URls. Query parameters include: Limit, Pagesize, and Offset. |
| 
