2.8 OBO API testing via postman

This topic provides information on OBO API testing via postman.

OBO API’s testing: The below curl command is used to test the OBO APIs before integrating with OBDX application and to check if it is working with expected headers

    • Product listing

      This API is used to fetch the list of products that are maintained in OBO.

      curl --location
              '<protocol>://<ip>:<port>/obremo-rpm-businessproductdetails-services/web/businessproducts?channel=OBDX&productType=<product_type>&productCategory=IND'
              \--header 'Content-Type: application/json'
              \--header 'userId: <user_id>' \--header 'appId: OBREMOBPDETAILS'
            \--header 'branchCode: <branch_code>'
            \
          --header 'entityId: DEFAULTENTITY'
      • To verify and set <protocol>://<ip>:<port>
      • Open Eureka URL and search for endpoint obremo-rpm-businessproductdetails-services
      • Open result URL in new tab and refer protocol, IP, and port for use in curl
      • <user_id> : User created in OBO e.g. OBDXAPI1
      • <branch_code> : OBO branch code
      • <product_type> :
        • S for savings
        • C for current account
        • L for loan
        • T for term deposite
        • R for creadit card
        • V for auto loan
        • H for home loan
        • E for education loan
  1. Read application

    This API is used to fetch application details using the application number.

    curl --location
            '<protocol>://<host>:<port>/obremo-rpm-process-driver-services/service/getData/<application_id>'
            \--header 'branchCode: <branch_code>'
            \--header 'appId: RPMPROCESSDRIVER'
            \--header 'entityId: DEFAULTENTITY'
            \--header 'userId: <user_id>'
            \--header 'Content-Type:
              application/json'
    • Follow the steps of Product listing api to set <protocol>, <host>, <port>, <branch_code>, <user_id>

      Open Eureka URL and search for endpoint obremo-rpm-process-driver-services

    • <application_id> Enter the application number, for which you have to fetch details
  2. Enumeration

    This API fetches a list of values from OBO, e.g. The following API is used to fetch the list of values maintained for the Salutation dropdown.

    curl --location
            '<protocol>://<host>:<port>/obpy-party-maintenance-service/service/v1/retail/getAll?entityCode=<entity_code>'
            \--header 'Content-Type:
            application/json' \--header 'userId: <user_id>'
            \--header 'appId: PRTONB'
            \--header 'branchCode: <branch_code>'
            \--header 'entityId: DEFAULTENTITY'
            \--header 'authToken: TOEKN'
  3. Get Token

    This API is used to generate a token. This token will further be used in any api-gateway call.

    curl --location '<protocol>://<host>:<port>/api-gateway/platojwtauth/' 
    \--header 'appId: SECSRV001' \--header 'Content-Type: application/json'--data '
    {"username": "<encoded_user_name>","password": "<encoded_password> "}'
    • Follow the steps of Product listing api to set <protocol>, <host>, <port>

      Open Eureka URL and search for end-point apigateway-router

    • Please refer the OBRH encoding technical documentation to check the encoding that is used by the application for user name and password setup.

    Base64 is standard encoding use the same to set above username and password.

  4. Document type

    This API is used to fetch the list of primary document types that the user can upload in the application.

    curl --location '<protocol>://<ip>:<port>/api-gateway/cmc-documentmanagement-services/documenttype'
            \--header 'Content-Type: application/json' \--header 'userId: <user_id>' 
    \--header 'appId: CMNCORE' \--header 'branchCode: <branch_code>' \--header 
    'entityId: DEFAULTENTITY' \--header 'Authorization: Bearer <token>'
    • Follow the steps of Product listing api to set <protocol>, <host>, <port>, <user_id>, <branch_code>\B

      Open Eureka URL and search for end-point apigateway-router

    • Kindly refer the Get Token API response to set Bearer <token>

    Note:

    Contact OBO consulting team for any query related to OBO API e.g. Product creation, maintenance and others.