<aside> 📌 Prerequisites

  1. An Aqurate account (get it at aqurate.ai)
  2. An active integration of your Shop data (how to connect your shop)
  3. An active subscription with Aqurate Recommendations

</aside>

<aside> 📖 Resources Check out and test our endpoints in the Recommendation section of our docs.

</aside>

1. Authentication

To query the endpoints, you need to generate an API key on the API Keys management page. You should generate a custom key with the scopes read:item_recs and read:user_recs.

When making API calls, use the generated API key for the X-Auth-Token parameter**.**

<aside> 🔒 Keep you API keys safe, as they can be used to access the data in your Aqurate account. For your security, API keys can only be viewed once. If you lose an API key, you can easily revoke it and generate a new one.

</aside>

<aside> 💡 Optionally, you can also enable the read:item_features and read:user_features to enable the /item and /user endpoints respectively. There endpoints deliver item and user information.

If you want to use the same API key to connect your shop to Aqurate, also enable the write:input_table scope. More details on the Shop integration via API guide.

</aside>

2. Get product recommendations

The Aqurate Recommendations API offers two types of endpoints:

For item-to-item recommendations, there are four different resources:

  1. recs/item/similar
  2. recs/item/up-sell (🚧 to be deprecated in this form 🚧
  3. recs/item/cross-sell
  4. recs/item/substitutes

All of these endpoints: