API for the Alteryx License Portal

Hello,

I am a newbie with API's and wanted to build a quick workflow to connect to the data in our license portal. (both for educational purposes - learning about API's and building a functional workflow to track licenses)

Once I log in to the portal I see the API screen, which has the access token, refresh token and how to request it programmatically.

API docs are there but this is gibberish to me.

Trying to connect using the download tool but I don't know what I'm doing and no matter what I do it errors out.

Please help,

Thx,

API

Accepted answers

richardbryantapd

Hi @sp210708,

See the attached workflow for a sample that will call the Devices API. There are instructions in the bottom-left corner of the workflow.

There are two key pieces. First, you generate the tokens on the Alteryx licensing portal. After you log in, left-click the circle in the top-right corner and choose "API Access" from the drop-down menu.

Second, you can use the headers tab in the Download tool to pass your access token. The field should be named "Authorization" and its value should be "Bearer " + [field_containing_your_access_token]. See the attached workflow for details.

Regards,

Richard

alteryx_license_portal_api_extract.yxmd

All comments

ArnaldoSandoval

Hi @sp210708

Before jumping into deep waters, I strongly suggest these resources:

Webinar - Using Alteryx to extract foreign exchange rates in real time This is a lovely 1 hour video explaining APIs; it is a good starting point; with a Foreign Exchange real time implementation.
The Guardian Open platform.

API's in Alteryx

You may also read my reply to this question in the community: Open People Search | Alteryx API Connection

Enjoy the learning.

Arnaldo

sp210708

Thanks @ArnaldoSandoval

I'm into the webinar however parts are outdated. I can't just replicate the webinar as the api site now requires a login.

There is also a DCM connection manager which doesn't exist in the webinar.

I created a login for the site, and added credentials to the DCM which is different from the video and now I'm getting an error saying my subscription doesn't have HTTPS encryption. I've deviated so far from the video at this point I'm not sure what I'm doing wrong.

Here is the response I get from the DownloadData column

{"error":{"code":"https_access_restricted","message":"Access Restricted - Your current Subscription Plan does not support HTTPS Encryption."}}

sp210708

Edit @ArnaldoSandoval I removed the s from https and getting the call,

thanks,

ArnaldoSandoval

Hi @sp210708

I attached the Guardian API, (The Guardian Open Platform); I haven't tried the first one.

Arnaldo

Guardian-API-01.yxmd

sp210708

Has anyone got the Alteryx API to work? I have the basics down however I am missing something.

I have got API's to work across 3 separate APIs however I am stuck on this one. It is continually telling me error 401 insufficient access.

However I put in my credentials in the DCM still an error.

Also I have an Access token but in the API documentation there is no use of this API token???

I tried adding ?api_key=xxxxx but still getting the error and there is no documentation on this I am seeing?

here is the API documentation - however there is no mention of the API token,

https://us1.alteryxcloud.com/license-portal/api/swagger-ui/index.html#/Device%20Resource/findDevicesByAccountId

richardbryantapd

Hi @sp210708,

See the attached workflow for a sample that will call the Devices API. There are instructions in the bottom-left corner of the workflow.

Regards,

Richard

alteryx_license_portal_api_extract.yxmd

sp210708

Thanks @richardbryantapd - it is working now!

The only issue is that some of the data is incorrect. For some reason it is showing some inactive licenses as active licenses as well as the last modified date and last request time are different than what they show in the license portal.

Any idea why the data wouldn't align?

Thanks,

Shane

richardbryantapd

I don't have any ideas on that. You would probably have to contact Alteryx directly for more details.

It may be worth investigating other endpoints (/users, for example) to see if there are overlapping fields with /devices and if the information is consistent with /devices and what shows in the license portal.

carl_cimino

How would you automate this in a workflow that then feeds into the solution above?

amsrivastav

Hi,

Please share your Alteryx flow where are fetching the data from Alteryx License Portal for the users.

Thanks

Amit

carl_cimino

API Flow Pic.png

amsrivastav

Hi @carl_cimino,

Thanks for the reply.

Could you please share the Alteryx flow with me, it would be quite helpful and appreciated.

Thanks

Amit

carl_cimino

Attached. You should just need to put your refresh and access tokens as well as your account number in the appropriate tools.

alteryx_license_portal_api_extract_share.yxmd

Quick Links

This months top contributors

mceleavey 383

mbarone 337

Hollingsworth 335

LanisC 335

RithiS 280