topic Migration guide — Migrate an API key integration to a private app in APIs & Integrations

Migration guide — Migrate an API key integration to a private app

Jaycee_Lewis — Fri, 15 Jul 2022 23:27:40 GMT

Hey, HubSpot Developers! There are plenty of questions about the upcoming sunset and how to migrate your apps using API keys to use Private Apps.

Luckily, our amazing team put together this guide, Migrate an API key integration to a private app ✅

Changelog information here — Upcoming: API Key Sunset

If you have questions about the guide or the information included, please leave your feedback in the comments. If you have specific questions about migration of your app, please consider starting a new thread. This will help make sure your request gets the attention it deserves from our community.

Have fun coding! — Jaycee 🧡

Re: Migration guide — Migrate an API key integration to a private app

MWeddup — Wed, 27 Jul 2022 08:27:29 GMT

I've been attempting to migrate from API KEY auth to Private App using the guide, but the scopes on the Private App were causing difficulty, the e-commerce scope had been added to the Private App ( and the key rotated ) but the calls to the API using the Private App are still giving "One or more of the following scopes are required." requiredScopes":["e-commerce"] turned out to be attempting to use the e-commerce on the Products on a non-enterprise/non-professional account, would be handy if the guide had a reminder or the api message was more specific

Re: Migration guide — Migrate an API key integration to a private app

Jaycee_Lewis — Wed, 27 Jul 2022 19:53:13 GMT

Thanks for your feedback, @MWeddup 🙌 I'll pass it along to my team. — Jaycee

Re: Migration guide — Migrate an API key integration to a private app

GDell — Thu, 28 Jul 2022 13:29:22 GMT

Hi, we've moved to the new method, but we can't get the Blog Author Name and Blog Author Image and these aren't mentioned in the documentation. Can you advise?

Re: Migration guide — Migrate an API key integration to a private app

GustavoOliveira — Thu, 28 Jul 2022 21:29:04 GMT

Hi, we are preparing to move to the new method. On the Article Guide it directs to the V3 API Enpoints.
My question is, on the required method, Private Apps, is the only possible API available for the new method the V3 API?

One of the features only possible in the V1 API is the Property History, and we wanted to keep this feature after the change.

Re: Migration guide — Migrate an API key integration to a private app

Jaycee_Lewis — Fri, 29 Jul 2022 16:00:34 GMT

Hey, @GustavoOliveira 👋 I am happy to check for us.

Can you tell me specifically which v1 API you are referring to? For example, the Get a contact by vid endpoint works with private apps.

Thank you! — Jaycee

Re: Migration guide — Migrate an API key integration to a private app

Jaycee_Lewis — Fri, 29 Jul 2022 16:02:19 GMT

Hey, @GDell 👋 Which endpoint are you referring to? I am happy to take a brief look.

Best,

Jaycee

Re: Migration guide — Migrate an API key integration to a private app

GDell — Fri, 29 Jul 2022 16:19:53 GMT

https://api.hubapi.com/blogs/v3/blog-authors/

It's this one. Just need the equivalent for both Blog Author Name and associated image.

The new API is returning the user who created the post rather than the user the post is assigned to

Re: Migration guide — Migrate an API key integration to a private app

GDell — Mon, 01 Aug 2022 13:21:21 GMT

Just more info:

We are using the Blog endpoints here https://developers.hubspot.com/docs/api/cms/blog-post, see Endpoints tab. The "authorName": "string" seems to return the name of the user creating the post, rather than the Author assigned to it. And there is no endpoint for Author image in this list. Hope this helps.

Re: Migration guide — Migrate an API key integration to a private app

GustavoOliveira — Mon, 01 Aug 2022 16:16:26 GMT

Thanks!

It's the Get all deals (hubspot.com) or Get a deal | Deals API (hubspot.com) enpoints. But specifcally the parameters to get all version of a property ("Properties with History" and "Include property versions", respectively), which is something the newer APIs don't seem to provide.

Re: Migration guide — Migrate an API key integration to a private app

Jaycee_Lewis — Mon, 01 Aug 2022 22:11:07 GMT

Hey, @GustavoOliveira 👋 Thank you very much for clarifying. I successfully ran quick tests of both v1 endpoints using Postman and included the additional params:

Get all deals

Endpoint GET https://api.hubapi.com/deals/v1/deal/paged?propertiesWithHistory=dealname
Response (edited to only include the relevant Deal)
{ "portalId": 22245342, "dealId": 9669508372, "isDeleted": false, "associations": null, "properties": { "dealname": { "value": "Changer v2", "timestamp": 1659390587045, "source": "CRM_UI", "sourceId": "userId:10233975", "updatedByUserId": 10233975, "versions": [ { "name": "dealname", "value": "Changer v2", "timestamp": 1659390587045, "sourceId": "userId:10233975", "source": "CRM_UI", "sourceVid": [], "updatedByUserId": 10233975 }, { "name": "dealname", "value": "Changer v1", "timestamp": 1659390567632, "source": "CRM_UI", "sourceVid": [], "updatedByUserId": 10233975 } ] } }, "stateChanges": [] } ], "hasMore": false, "offset": 9669508373

Get a deal

Endpoint GET https://api.hubapi.com/deals/v1/deal/9669508372?includePropertyVersions=true
Response (edited to include only the relevant deal property)
"dealname": { "value": "Changer v2", "timestamp": 1659390587045, "source": "CRM_UI", "sourceId": "userId:10233975", "updatedByUserId": 10233975, "versions": [ { "name": "dealname", "value": "Changer v2", "timestamp": 1659390587045, "sourceId": "userId:10233975", "source": "CRM_UI", "sourceVid": [], "updatedByUserId": 10233975 }, { "name": "dealname", "value": "Changer v1", "timestamp": 1659390567632, "source": "CRM_UI", "sourceVid": [], "updatedByUserId": 10233975 } ] },

Thank you for asking this question. It helps other community members as well as helping us identify areas where more clarity is needed.

Best,

Jaycee

Re: Migration guide — Migrate an API key integration to a private app

Jaycee_Lewis — Mon, 01 Aug 2022 22:12:17 GMT

I forgot the most important detail 🙃 Both of these requests were made using a Private App I created in my app testing account. — Jaycee

Re: Migration guide — Migrate an API key integration to a private app

JOrtuno — Tue, 02 Aug 2022 10:49:47 GMT

Hi HubSpot Developers 🙂,

I have a similar problem as others when using a method from the V1 version:

https://api.hubapi.com/integrations/v1/limit/daily

Even though the Private App that we created was allowing the access to every scope.

The message error is the following: "The scope needed for this API call isn't available for public use. If you have questions, contact support or post in our developer forum."

Thanks for your time!

Re: Migration guide — Migrate an API key integration to a private app

GustavoOliveira — Tue, 02 Aug 2022 13:22:11 GMT

Thank you so much for the answer, it's really thorough.

Now it's clear that I can make this change.

Re: Migration guide — Migrate an API key integration to a private app

NHalim — Fri, 05 Aug 2022 04:06:25 GMT

Hi,

Can the access token of Private App be rotated by manual interaction only?

Does it have refresh token to regenerate token?

Many thanks!

Re: Migration guide — Migrate an API key integration to a private app

JOConnell2 — Sat, 17 Sep 2022 02:01:39 GMT

Hi,

I have migrated our serverless functions over to using a private app by including the Authorisation header and have updated the Hubspot Client Library calls to include the access token of the new private app.

What i don't know how to do is change the call made by HubL functions within our HTML, for example:

{% set contacts = crm_associations(propertyID, "USER_DEFINED", ASSOCIATION_TYPE_CONTACT_TO_COMAPNY, "","phone,firstname,lastname,email,ownership_status,customer_services_owner") %}

When I check the logs I see traffic coming in using the old API key, where is the authorisastion for this function set?

Regards,

Jordan

Re: Migration guide — Migrate an API key integration to a private app

JOConnell2 — Sat, 17 Sep 2022 22:36:04 GMT

How do HubL calls authenticate? I have changed our severless functions to use the authorisation header with the access code from our private app and i have changed our calls that use the client libraries to use the access code also.

I cannot find out how to change the authorization method of my HubL calls present in our dynamic pages. I can see from the API logs that the HubL calls continue to use the old API key.

Re: Migration guide — Migrate an API key integration to a private app

Vivre — Tue, 20 Sep 2022 23:21:45 GMT

This might be a stupid question sorry (not a developer) - this migration wont affect any public apps installed right? i.e from the Marketplace

Re: Migration guide — Migrate an API key integration to a private app

LKlaßen — Mon, 26 Sep 2022 15:17:31 GMT

Hello,

I have a question relating to this topic.
We have to change our custom code in workflows (python) from Key to Token.
In my console, the code works fine. Easy to change, but in the workflow I get an Error.

console:

from hubspot import HubSpot from hubspot.crm.quotes import ApiException hubspot = HubSpot(access_token=token) hubspot.crm.quotes.associations_api.get_all(quote_id="56948949", to_object_type="deal", limit=1) -> {'paging': None, 'results': [{'id': '5529167352', 'type': 'quote_to_deal'}]}

workflow

from hubspot import HubSpot from hubspot.crm.quotes import ApiException hubspot = HubSpot(access_token=os.getenv("HTOKEN")) hubspot.crm.quotes.associations_api.get_all(quote_id="56948949", to_object_type="deal", limit=1) -> [ERROR] ApiException: (401) Reason: Unauthorized HTTP response body: {"status":"error","message":"Authentication credentials not found. This API supports both API Key and OAuth 2.0 authentication and you can find more details at https://developers.hubspot.com/docs/methods/auth/oauth-overview","correlationId":"a166f3d7-1fb9-46f5-a7cf-9fee0787b985","category":"INVALID_AUTHENTICATION"}

Re: Migration guide — Migrate an API key integration to a private app

Agilx — Fri, 14 Oct 2022 15:20:53 GMT

Any update on this? I'm getting the same error using a developer account that was just renewed. Created a Private APP with the e-commerce scope and I can't create Projects.