cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
abedkhooli Frequent Visitor
Frequent Visitor

Refreshing a Restful Data Source with API Key

I have a REST API data source which I connected to successfully from Power BI Desktop (using Feb. version).  When I publish to service (free), I can't refresh: "Your data source can't be refreshed because the credentials are invalid. Please update your credentials and try again".

In the Data Source Credentials / edit credentials, I have 3 options: anonymous, windows and basic. No option to enter key.

In desktop, I finally used (had to use parameters as a work around for refresh and #"param" for the "-" char):

Source = Json.Document(Web.Contents("https://api......./messages/topic", 
[RelativePath = "/.....141", ApiKeyName = "api-key", 
Query = [#"start-date" = dt5, #"end-date" = dt2 ] ])),

and entered the key in the interface (web api). I also tried sending it in header: Headers=[Authorization="api-key <key>"]. 

Is refresh for this scenario supported in service?

 

1 ACCEPTED SOLUTION

Accepted Solutions
Moderator v-yuezhe-msft
Moderator

Re: Refreshing a Restful Data Source with API Key

Hi @abedkhooli,

Based on my research,  using the ApiKeyName option isn't supported in the Power BI service .

And if the root URL of the your api works with anonymous access, you can publish the report that uses the Headers option to pass an API key and the refresh should work in Power BI Service. However, if your root URL returns error with anonymous access, refresh in Power BI Service will fail, you can use fso’s workaround that execute the query elsewhere and connect Power BI to that as a data source.

Thanks,
Lydia Zhang

Community Support Team _ Lydia Zhang
If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.
2 REPLIES 2
Moderator v-yuezhe-msft
Moderator

Re: Refreshing a Restful Data Source with API Key

Hi @abedkhooli,

Based on my research,  using the ApiKeyName option isn't supported in the Power BI service .

And if the root URL of the your api works with anonymous access, you can publish the report that uses the Headers option to pass an API key and the refresh should work in Power BI Service. However, if your root URL returns error with anonymous access, refresh in Power BI Service will fail, you can use fso’s workaround that execute the query elsewhere and connect Power BI to that as a data source.

Thanks,
Lydia Zhang

Community Support Team _ Lydia Zhang
If this post helps, then please consider Accept it as the solution to help the other members find it more quickly.
abedkhooli Frequent Visitor
Frequent Visitor

Re: Refreshing a Restful Data Source with API Key

Thank you @v-yuezhe-msft for the tip. I just kept the root part of the url (public but redirects to html file) and add the rest to relative path. so, it reads:

 Source = Json.Document(Web.Contents("https://api.***.io/", 
[RelativePath = "v1/*****141", Headers=[Authorization="api-key 42****c4"],
Query = [#"start-date" = dt5, #"end-date" = dt2 ] ])),

When published to service, it did not refresh at first and gave same error. However, went to settings and edit credentials, signed in as anonymous (accepted) and it worked. Hopefully, this will be sorted out in future updates.