Reltio Integration Hub

 View Only
  • 1.  Any sample REST API developed in RIH?

    Posted 11-02-2022 06:34
    Hi,

    Can someone please share any sample REST API developed in RIH? What will be the end point to test it?

    Thanks & Regards,
    Niranjan

    ------------------------------
    Niranjan Babu Bandla
    HP Inc.
    Bangalore
    ------------------------------


  • 2.  RE: Any sample REST API developed in RIH?

    Reltio Employee
    Posted 11-02-2022 10:06
    Hi Niranjan,

    I made use of the RIH/Workato docs here:


    Let me see if I can take you through the steps:

    1) Make sure that "API Platform" is enabled for your RIH environments. 

    2) Build your recipe, triggered like this

    3) Make sure that there is a RETURN action (response to the API)

    4) Go to API Platform via the left menu

    5) Define an API Collection

    6) Define an Endpoint, using your API recipe.  Note that the URL is displayed, and is a concatenation of a base, your API Collection, and your Endpoint

    7) For your API Collection, now define a Client

    8) For the Client, create an access profile.  There are choices here for how to authenticate.  I chose the easiest, to let RIH generate me a token to use in my calls

    9) Start the Recipe (will start the other components)

    10) Test.  Here's my Postman example.  Note the additional Header with API-TOKEN, and the value copied from step 8.

    I hope this helps.

    Regards,
    Matt
    ------------------------------
    Matthew Gagan
    ------------------------------



  • 3.  RE: Any sample REST API developed in RIH?

    Posted 11-07-2022 22:52
    Thank you Mathew for the response. We have not enabled the API Platform in our RIH environments. To enable API platform, do we need to submit Zendesk ticket?
    Please let us know if any additional security measurements to take post enabling the API platform.

    Thanks & Regards,
    Niranjan

    ------------------------------
    Niranjan Babu Bandla
    HP Inc.
    Bangalore
    ------------------------------



  • 4.  RE: Any sample REST API developed in RIH?

    Reltio Employee
    Posted 11-08-2022 07:52
    Hi Niranjan,

    Yes, to have the API platform enabled you will need to submit a ticket.

    Security: RIH supports several different authentication methods to operate the API, detailed in the documentation here.

    Additional security note: When you design your API recipe, you will be embedding a single set of Reltio credentials - a one-size-fits-all that needs sufficient permissions to execute all functions of the recipe, and accessing all necessary data.  If the API is then deployed for shared usage e.g. to function as a search-before-create endpoint for other apps, you'll want to think through the design to ensure that end users with restricted permissions are not inadvertently exposed to data that they should not see.

    Regards,
    Matt

    ------------------------------
    Matthew Gagan
    ------------------------------