Every call to a Kariz API must include an API secret key. After you create an Kariz Account, we will generate this API key. It has to be included in every request that you send to us so we can authenticate you.

​
What you will built

If you haven’t already, book a demo with us to get your account credentials. Here you will receive your application API key, every time you want to connect to connect to Kariz, this needs to be included in your request to our API.

​
Step 1: Create a developer account

If you haven’t already, book a demo with us to get your account credentials. Here you will receive your application API key, every time you want to connect to connect to Kariz, this needs to be included in your request to our API.

​
Step 2: Authenticate a user

There are 2 ways to authenticate a user in Kariz. Using our generic authenticator or using token authentication. The second is recommended for testing with existing users or if you want to keep your style for the integration page. For more information on the different authentication methods click here. For this tutorial we will use our generic authenticator as this is the quickest way to setup.

To create a authentication link for users, with our generic authenticator, you need to send us 3 parameters:

  • Application API key

  • Sales channel(s)

  • User name

The application API key you received from us before, you need to send it in every request to us so we authenticate your requests.

The Sales channel(s) you send in the requests to us will determine what your end user will be asked to authenticate with. This can be one channel (shopify) but it can also be multiple channels at the same time (Shopify, WooCommerce and Amazon).

The username, in order to authenticate a user for you, we need to know how to call the user. This code will be used later to retrieve data for a client. When you send us a username in a request, that didn’t exisit yet. We are creating a new user for you in our database. When you send us a username that already existed in ourdatabase, we will update that record to include new sales channels or update old ones.

​
Step 3: Request data

Now that you have autenticated a user, you can request data from them on the different sales channels. The data will always be returned in exactly the same format. To try this out, we recommend retrieving order data.

​
Complete

Now you can integrate to any of the E-commerce channels Kariz is connected to.

Overview