Introduction to API

Goals and Outcomes

This short introduction will help you understand the basics of making API calls, including the required credentials and how to read responses. At the end of this article, you will be able to use API calls to generate your access token.

API Basics

API is a method used by two or more pieces of software to communicate over the internet. This communication happens using various types of calls such as a get call which asks for data to be sent over or a push call which sends data to be added usually to a database.

Why use API calls? Excellent question! For 3rd party applications or when using an eCommerce platform that doesn’t have an out-of-the-box integration with Yotpo, API calls are the best way to transfer data to and from your Yotpo apps.

Getting Started

To utilize Yotpo SMS & Email API calls you will need to gather your required credentials:

• App Key

• Secret Key

App Key

To access your app key, log into your Yotpo SMS & Email account. Once in your account follow the process below:

1. Click on the profile icon in the top right-hand corner.

2. Click on Account Settings which will take you to your General Settings in Yotpo.

3. Under the API Credentials, you will see a box marked App Key and a greyed-out string of letters and numbers. This is your app key, and you copy it to your API platforms, such as Postman or another space for safekeeping.

Visual Walkthrough

Generating Your Secret Key

To generate your secret key follow the steps below:

1. Access your API Credentials in your Yotpo General Settings.

2. Click the Get secret key button under the App Key.

3. Yotpo will send a verification code to the admin email listed on your account. Enter that code into the code box and click the Submit button.

4. Your secret key will appear in a popup. Click the copy to clipboard button and paste it into a safe space.

5. Click the Close button or the X in the top right corner of the popup.

Note:

The verification code is only valid for 60 minutes and will need to be regenerated once the time has elapsed.

Warning:

Your secret key allows access to your data so it should only be shared with trusted parties.

Visual Walkthrough

Making Your First API Call

Before making any API calls to add or alter data in your Yotpo account, you will first need to make an API call to generate your utoken.

What is an utoken?

This token allows you and your developers to make calls, particularly post calls to your Yotpo apps.

Generating Your uToken

You can use our API documentation to generate this token linked below to help build your API call:

Generate a utoken

Within this documentation, you can copy-paste the app key and secret key you previously retrieved into Body Params, which build the body JSON necessary for the call. Once you have sent this call, you will receive back your access token, which will allow you to perform more API calls, such as creating test contacts and test orders, as well as sending authentic data.

For more information on our API calls, see our API documentation.