What is an API key?
The API key is a Universal Unique Identifier (UUID) generated by our system.
This will be a 32 bit alphanumeric string. E.g.
15458617-7813-4a37-94ac-a8e6da6f6405
Why do I need an API Key?
You will need an API key to access the Shopping.com API 3.0. The purpose of
the API key is to give secure access to the API only to the owner of the
key.
I do not have an API license, how do I get an API Key?
You must first apply and get approval for an API license before receiving an
API Key. You may do so by logging into PAC, go to the Product Suite tab and
click on the link 'Enroll in the API Program.'
An API key and tracking ID will be generated upon the approval of your
application, this information will be sent to you in an email. You will also be
able to see this information in the Partner Account Center (PAC)
I am currently using API version 2 with a Linkin ID. How do I switch
to the new API version 3? Where can I find my API information?
In order to switch to API version 3, you will have to ensure that you are
using BOTH API Key and Tracking ID in your API query call. Use cases on how to
construct API 3 query URLs can be found here: http://developer.shopping.com/docs/API_Use_Cases.
API Key and Tracking ID(s) can both be found in the Partner Account Center under the Product Suite tab. On the
top right, you will see the link 'Manage your API Information'. Clicking on this
link will take you to the API Information page, where you will see the API Keys
and the Tracking IDs.
How do I use the API Key?
You will have to pass the API key and the Tracking ID in your API call. It is
required that you simultaneously pass a valid and active API key with a valid
Tracking ID. The API will not return any results if the API key is invalid or
expired or if the Tracking ID is invalid or expired. The API key is used for
security and the Tracking ID is used for tracking your performance.
Example of API call with the API key & Tracking ID http://sandbox.api.shopping.com/publisher/3.0/rest/GeneralSearch?apiKey=authorized-key&trackingId=7000610&keyword=nikon
Is an API key specific to a Tracking ID?
No, you can use your API key for all of your Tracking IDs. Unless needed, we
suggest that you use one API key for all your Tracking IDs.
What is a Tracking ID?
Tracking ID has the same functionality as Linkin ID but just with a different
name. It the parameter that will track revenue generated from your website's
traffic. You will still be able to view your account's Tracking ID(s) in your Partner Account Center under the
'Product Suite' tab and click on the Manage Your API Information.
I
have both the API key & Tracking ID, are there any documentations on API
version 3?
All API version 3 documentation are online at http://developer.shopping.com/docs
which includes API
use cases, API schema,
JAVA SDK and
more!
Where do I see my API Key information in PAC?
Log into the Partner Account
Center, click on the Product Suite tab. On the top right, you will see the
link 'Manage your API Information'. Clicking on this link will take you to the
API Information page, where you will see the API Keys and the Tracking
IDs.
Can I create another API Key?
You can create another key from the Manage your API page in the PAC. Click on
the Create API Key link. Enter your key and click Submit. Your API key will be
created.
Is there an expiration date for the API Key?
There is no expiration date for the API Key, however if you want you can set
an expiration date.
Can I expire an API Key?
Yes, you can click on the Expire link next to the API Key and expire the
key.
There will be 2 options for the expiry date:
1. You can choose to expire at that time
2. You can schedule a date in the future to expire the API Key
Can I reactivate an expired API Key?
Yes, once your key is expired, you will see the status change to Expired and
there will be a new link Reactivate. Clicking on the Reactivate link will
activate your API key.
What does the disabled status mean?
If you see a status Disabled, it means that the Account Managers from
Shopping.com has disabled your access to the API. Your may submit a case to Shopping.com Partners
Management if you have any questions.
Have more questions? Submit a
case to us here and we will
get back to
you!
