Topics:
· Access to Customer Screening (CS) service.
· Appropriate user privileges to access the services.
· Technical and functional knowledge to understand and execute the REST APIs and configuration knowledge.
· Knowledge of REST concepts, JSON, browser-based REST client.
· Knowledge of an interactive and automatic tool for verifying the APIs such as Postman.
The account creation e-mail from Oracle contains the identity domain name for the Oracle Customer Screening Cloud instance. If you do not have this information, then contact your service administrator.
Ensure that you have the appropriate log-in credentials for accessing the Oracle Customer Screening cloud service, and the appropriate role for creating, managing, and deleting service instances.
To get authentication, follow these steps:
1. Log in to Admin Console. For more information, see Admin Console.
2. Go to Component Details and click AUTH tab. The Client ID and Client Password details are displayed.
3. Copy Client ID and Client password.
4. Open Postman or relevant API tools. Select POST method and paste the URL: https://ip:port/oauth2/v1/token.
NOTE: Replace ip:port with tenant URL or domain name.
5. Click the Authorization tab. Go to the Type field and select Basic Auth from the drop-down list. The User name and Password fields are displayed.
6. Enter the User Name and Password that you have copied in step-3.
7. Go to the Body tab. Select request format as: x-www-form-urlencoded.
8. Enter the KEY and Value fields as mentioned in the table:
The following table explains the KEY and VALUE details.
KEY |
VALUE |
grant_type |
client_credentials |
scope |
urn:opc:idm:__myscopes__ |
9. Click the Header tab. The Header details are displayed.
10. Enter the details explained in the following table:
KEY |
VALUE |
Postman-Token |
client_credentials |
scope |
urn:opc:idm:__myscopes__ |
Content-Type |
application/x-www-form-urlencoded |
Content -Length |
<calculated when request is sent> |
Host |
<calculated when request is sent> |
User-Agent |
PostmanRuntime/7.28.0 |
Accept |
*/* |
Accept-Encoding |
gzip,deflate,br |
Connection |
keep-alive |
11. Click Send. An Authorization token is generated in the Response body. For example, <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>
NOTE: This authentication key is valid for a stipulated time.
12. Copy only the Authorization token details.
To execute Customer Screening Realtime Request, follow these steps:
1. Open Postman or relevant tool.
2. Copy only the Authorization token that you got from the previous request.
3. Go to Header.
4. Enter KEY as a Authentication and Description as a bearer (Authorization token) <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>.
5. Send a request using the POST method. The request must be in the following format:
§ HTTP Link: http://hostname:port/api.
§ Path: /csxe-real-time/executeRealTime
You will get a response as an integer value (for example, "requestId": 141) which has to be passed in the Get RTevent API {requestID}. For more information, see the GET RT events Request section.
To execute RT event request, follow these steps:
1. Open Postman or relevant tool.
2. Copy only the Authorization token in the previous request.
3. Go to the Header tab.
4. Enter KEY as an Authentication and Description as a bearer (Authorization token) <eyJ4NXQjUzI1NiI6Ikk3cWxndm1Kal...>. .
5. Send a request using the GET method. The request must be in the following format:
§ HTTP Link:http://hostname:port/api.
§ Path : csxe-real-time/RTEvents/getForRequestId/{requestID}
You will get a response as an event generated for the particular request ID.
· GET: Retrieve information about the service instance.
· POST: Create, scale, backup, start, and stop the service instance.
· PUT: Update the service instance.
The following media type is supported by the Oracle Customer Screening Cloud REST API:
· application/json
The REST API supports headers that may be passed in the header section of an HTTP request or response.
When you call any of the Oracle Customer Screening Cloud REST resources, the Response header returns one of the standard HTTP status codes.
.