1 Rest API Services - Overview
Oracle Banking Trade Finance Cloud Service has adopted the industry standard of providing light-weight services through Representational State Transfer (popularly known as ReST) services. These lightweight services support the current trend of mobile/tablet based applications. These services help to improve the response time for tablet/mobile applications, as these applications are very chatty, involves numerous hits to the server and the expected response time is minimal for each of the requests.
The REST/Fine grain services using GET methods are listed below:
- LC Details
- Guarantee Details
- Bills and Collections
Each of the services listed above will be a URL. These URLs can be tested using any
of the available browser plug-ins like Postman, RestEasy etc.. Also these services can
be integrated with an API manager depending on its use. Below is the format of a Get
account balance service example which will take the customer account number and branch
code as the input
http://(IP):(Port)/ForeignCurrencyExchangeRates/QueryFXCurrencyRate/brncd/{brncd}/ccy1/{ccy1}/ccy2/{ccy2}
The input for the GET services is passed as a part of the URL and if more than one input needs to be passed they should be separated by a forward slash (/). Apart from passing the customer number as a part of the URL, the services also expect a few header parameters to be passed to the service. The following are the header parameters passed:
UserId, password and msgId are for authenticating the user accessing the service. More information on authentication can be found under Section 2.
Field | Description |
---|---|
userId | OBTF login user Id |
branch | The bank branch to which the user belongs. |
msgId | A alphanumeric input from the consumer. |
source | Source of the request whether it is OBTF or an external system. |
Content-Type | This mentions the format of the input /output. Since we are using the JSON format we will give the content-type as application/json. |
Entity | Entity ID |
The list of services will be discussed in detail in the following chapters.