Struggling with the REST API

Hi,

I would like to use the REST API in Board to access it outside of Board.
We are currently still using version 12.6.2.88217, but will soon be updating to Board 14.5. We have an on-premises installation.

I have read the following documentation on this topic:

https://help.board.com/docs/the-api-queries-section
https://community.board.com/discussion/18138/how-to-set-up-a-rest-api-connection
https://www.boardmanual.com/2023/summer/release-notes/board-2022-spring-release-release-notes/release-notes/main-features/rest-apis.htm

I have created an API client user and an API query under Data Model / API Queries.

There are two points in the documentation that I don't understand; I simply don't know what exactly I am supposed to do here:

Under System Administration / General Settings, I need to enter a URL under “Public API Client Redirect URIs.”
But which URL should I enter here? The URL from the API query?
I need an authorization token, but how exactly do I create one?
I can't understand the documentation on what steps I need to take to create an authorization token.

Can anyone help me with this?

Kind regards
Oliver

Find more posts tagged with

Administration

API

Accepted answers

All comments

Robert Barkaway

Hi Oliver, as far as I know that won't be possible with an on-premise setup, the API Oauth2.0 security requires the Subscription Hub which you won't have with an on-premise setup.

Robert Barkaway

Okay disregard that, it seems it is still possible with an On-Premise setup, I'm trying to find out the answers to your questions as the setup will be slightly different to a cloud setup for the reason I mentioned.

The URL for the token acquisition should be as shown below by the looks of it:

Björn Reuber

working also for OnPrem. you just need a different URI to get the token:

Grant Type: "Client Credentials"
Access Token URL: https://your_board_instance/identity/connect/token
Scope: "public-api"
Client Authentication: "Send client credentials in body"

Robert Barkaway

Thanks Bjorn - do you know the answer to Oliver's first question about the redirect URI?

Kevin Kowalski

Hello @Robert Barkaway and @Oliver Röll,

You can redirect URI from "General Settings" in your on-prem instance in "System Administration"

Kind Regards,

Kevin

Oliver Röll

Thank you very much for your answers, and sorry for my late reply, but I couldn't log into the community for a week. I kept getting an error message:

My Board Restful API call example in Postman is now working reasonably well.

Robert Barkaway

Good to hear you got your API call working! That login issue looks like it might be cookie related I'd have thought, glad you got it sorted.

Miran Saric

Hi @Oliver Röll, thank you for your message and our apologies for the login inconvenience in recent days. This issue has been resolved and you shouldn't have to experience it again in the future, please let me know if you encounter this error again.

Best,
Miran