topic Re: Migrating from API key to Private App in APIs & Integrations

Migrating from API key to Private App

LailaM — Thu, 09 Feb 2023 09:33:35 GMT

Could you assist me on API key migration.
I created the new Private app then tried to execute the code

$access_token = "<access token>"; $email = "test@gmail.com"; $url = "https://api.hubapi.com/crm/v3/objects/contacts/".$email."?idProperty=email"; $headers = [ "Authorization: Bearer ".$access_token, "Content-Type: application/json" ]; $post = array( 'properties' => array( 'online_course_completion' => 'YES' ), ); $ch = curl_init(); curl_setopt( $ch, CURLOPT_URL, $url ); curl_setopt( $ch, CURLOPT_CUSTOMREQUEST, "PATCH" ); curl_setopt( $ch, CURLOPT_HTTPHEADER, $headers ); curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $post ) ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); $response = curl_exec($ch); $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); if ($status_code == 200) { $response_json = json_decode($response, true); print_r($response_json); } else { echo "Request failed with status code: ".$status_code; }

but I'm always getting 404, and seing the response on hubspot log, it shows:

{"status":"error","message":"resource not found","correlationId":"dec53aa7-8a2d-42b1-8c01-68724152cfa9"}

Here is the code that is working with the API key for reference:

$url = 'https://api.hubapi.com/contacts/v1/contact/email/'.$email.'/profile?hapikey=' . $hubspot_api_key; $post = array( 'properties' => array( array( 'property' => 'online_course_completion', 'value' => 'YES', ) ), ); $ch = curl_init(); curl_setopt( $ch, CURLOPT_URL, $url ); curl_setopt( $ch, CURLOPT_POST, true ); curl_setopt( $ch, CURLOPT_HTTPHEADER, array( 'Content-Type:application/json' ) ); curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $post ) ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); $server_output = curl_exec( $ch ); curl_close( $ch );

Thank!

Re: Migrating from API key to Private App

skimura — Thu, 09 Feb 2023 11:01:05 GMT

@LailaM

How about this? (It use legacy api)

$url = 'https://api.hubapi.com/contacts/v1/contact/email/'.$email.'/profile?hapikey=' . $hubspot_api_key; $post = [ 'properties' => [ 'property' => 'online_course_completion', 'value' => 'YES' ] ]; $ch = curl_init(); curl_setopt( $ch, CURLOPT_URL, $url ); curl_setopt( $ch, CURLOPT_POST, true ); $headers = [ "Authorization: Bearer ".$access_token, "Content-Type: application/json" ]; // only change headers (add "Authorization") curl_setopt( $ch, CURLOPT_HTTPHEADER, $headers ); curl_setopt( $ch, CURLOPT_POSTFIELDS, json_encode( $post ) ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); $server_output = curl_exec( $ch ); curl_close( $ch );

When use legacy api, add header "Authorization: Bearer {TOKEN}".

https://legacydocs.hubspot.com/docs/methods/contacts/update_contact-by-email

Your new source code use hubspot api "v3".

>$url = "https://api.hubapi.com/crm/v3/objects/contacts/".$email."?idProperty=email";

But, this endpoint needs "contactId" instead of "email".

I think that's the reason for the 404.

PATCH /crm/v3/objects/contacts/{contactId}

https://developers.hubspot.jp/docs/api/crm/contacts

Thanks.

Re: Migrating from API key to Private App

LailaM — Thu, 09 Feb 2023 16:27:26 GMT

Hi,

The idea is to get rid of the API key which is already deprecated and can be take down at any moment and replace it with the private app, so I can't use the API key anymore.

With private app, I have to use hubspot api "v3" that's effectively needs "contactId" instead of "email" but I've read here https://developers.hubspot.com/docs/api/crm/contacts that you can give email as parameter if you add "?idProperty=email".

Please note: the idProperty query parameter doesn't appear on the Endpoints tab due to technical limitations, but it can be used for contacts exclusively with email. To use an email address as the unique identifier, set the idProperty as email and enter the email address in place of the contact ID. This should be set as a query parameter rather than added to the request body.

My question is why it's not working with email as parameter?

Thanks

Re: Migrating from API key to Private App

skimura — Fri, 10 Feb 2023 10:51:48 GMT

@LailaM

Hi.

Thank you for reply.

Your are right, sorry for wrong information

>?idProperty=email

I tested your new program, using api v3.

It works, using email registered in 'contact'.
But it is not works using email not in 'contact'.

This case, response is this.

Array ( [status] => error [message] => resource not found [correlationId] => ce12a676-c55e-4d6f-9764-9b62fbee265d )

So, Is "test@gmail.com" registered in 'contact'?

Or please test, another 'email' registered in 'contact'.

Thanks.