Rest API and EP3

[Thomas_Reu]

We are trying to setup the REST API property (p21 of the EP5 MRG), but this topic isn't even mentioned in the same-ish EP3 MRG:  "Integrating With Hyland IAM Services - OnBase Foundation EP3 Module Reference Guide.pdf"

Just to double check, does this mean the REST API setup won't work until EP5 or is the EP5 MRG relevant even if you are using EP3?

Note: I saw the following post from 2021, so I'm hopeful this may still be doable...

https://community.hyland.com/forum/threads/78147-how-to-implementing-pkce-auth-flow-with-the-rest-ap...

Regards...

[AdamShaneHyland · Accepted solution]

Hi @Tom ,

The REST API indeed works with OnBase Foundation EP3.  Information about setting up authentication is in the REST API SDK ...

https://sdk.onbase.com/rest/OnBase/Foundation22.1/document/programmers-guide/authentication.html

You will need to setup a Client in the Hyland IDP Admin Console based on the need of the client application.  The two current OAuth2 Grant Types (a.k.a. flows) which are supported are Authorization Code and Password.  Authorization Code is used when your client application has user interaction for authentication whereas Password is used when your application is making direct REST API calls to the API Server.  Configuration of the Client is different.

The article you referenced discusses Authorization Code.   Here are other resources which might be helpful ...

https://community.hyland.com/forum/threads/88736-signing-in-over-rest-api-w-password-auth

https://community.hyland.com/forum/threads/88591-rest-api-authentication

Best wishes.

[Thomas_Reu]

Thanks Adam.  Much appreciated.

[AdamShaneHyland]

You are welcome @Tom 

[Alan_Vidmar]

Tom,
While the REST API does work just fine in EP3 (we used it on a major integration with a 3rd party system) it may require additional licensing once you move up to EP5 or 22.1. EP3 did not require the licensing to use it.