question

bin0 avatar image
1 0 1 4

How to create clientID (APIKey) for Refinitiv Data Platform

When I try to create token to request for ESG data, I need to input Username (Machine ID), Password (Password of Machine ID) and Client ID. From guide, I can generate from https://emea1-apps.platform.refinitiv.com/apps/appkeygenerator. I logged in with my developer ID and generate a AppKey and use the App Key as client ID. then when I query esg data that token, I got "access denied". What is the client ID, how I get it?

rdp-apirefinitiv-data-platformesg
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

zoya faberov avatar image
28.3k 30 11 15

Hello @bin0 ,

From the output, it does look like you are missing the permissions, for RDP ESG, on the credentials supplied.

I would like to suggest to verify this with the Refinitiv person, who has assisted in requesting the RDP ESG permissions for you, this is likely your Refinitiv account manager, to be fully sure.

10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

zoya faberov avatar image
28.3k 30 11 15

Hello @bin0 ,

AppKeyGenerator is the correct way to generate CLIENT_ID. Please further refer to Quickstart guide for Refinitiv Data Platform.

If you have generated AppKey - it is your CLIENT_ID to use for RDP API access, you are absolutely correct in using it.

The details that I would suggest to check:

  • Is your ID permissioned to RDP ESG content? I would suggest to contact your Refinitiv account team to confirm, if your RDP ID is permissioned for ESG, and which ID, human, machineID, or both. Often, only human ID is permissioned for RDP static content.
  • Permissioned for RDP ESG content access, or for RDP ESG Bulk content?
  • Have you marked "EDP API" (this is the same as RDP API) when you generated the app key? This would be required, please see Quickstart for the detailed infromation

Hope that this helps to understand the cause

10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

bin0 avatar image
1 0 1 4

I did as follwoing screenshot but when I use App Key, my machine ID and machine id related password and use python to generate token and request data (https://api.refinitiv.com/data/environmental-social-governance/v2/views/basic?universe=IBM.N), I got following error

{"error":{"id":"59aa5e5f-054f-4422-9bee-240faebf4aab","code":"insufficient_scope","message":"access denied. Scopes required to access the resource: [trapi.data.esg.views-basic.read] or [trapi.demo-access]. Missing scopes: [trapi.data.esg.views-basic.read trapi.demo-access]","status":"Forbidden"}}

and which account I should log in to generate App Key, my machine ID, or my developer id?

key.jpg


key.jpg (57.5 KiB)
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

zoya faberov avatar image
28.3k 30 11 15

Hello @bin0 ,

Please use your RDP human user id, that is included in RDP Welcome email letter, to generate API Key.

However, I fully agree with @nick.zincone, requesting RDP ESG on RDP API Playground is an excellent way to verify the issue. If you are able to request ESG on API Playground, then the issue is with programmatic access, if you are not able to request RDP ESG on API Playground, the issue is with permissioning.

The human RDP credentials that you are logging into API Playground with, should be used to generate API Key (please see the link to APP Key generator on API Playground, top left corner)

appkeygen.gif

and next review, when you print your token, in section "scopes" do you see "esg*" scopes present?


appkeygen.gif (9.9 KiB)
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

bin0 avatar image
1 0 1 4

1. I tried use swagger from API playground to try following query, I got same error. but I check with support team, They said I had permission to access the ESG data?

2. "next review, when you print your token, in section "scopes" do you see "esg*" scopes present?" what's your mean? how could I see esg*. I did not understand this question.

{
  "error": {
    "id": "8019d203-4a87-4a6c-b890-b5cedbaba18a",
    "code": "insufficient_scope",
    "message": "access denied. Scopes required to access the resource: [trapi.data.esg.views-basic.read] or [trapi.demo-access]. Missing scopes: [trapi.data.esg.views-basic.read trapi.demo-access]",
    "status": "Forbidden"
  }
}
https://api.refinitiv.com/data/environmental-social-governance/v2/views/basic?universe=IBM.N
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.