Public APIs - Guide for developers to access Visual Quiz Builder’s endpoints.

This documentation will guide developers through all the information needed to access our API endpoints that are used to retrieve quiz data programatically.

Context

1. Generating a secret key
2. What is the purpose of the secret key?
3. How to generate the token?
4. How can you access Visual Quiz Builder data / VQB API endpoints?

Step - 1. Generating a secret key

• This secret key will be unique for each Visual Quiz Builder merchant / store
• The application will generate this and will be available in the Integration > VQB section of your Visual Quiz Builder dashboard

Step - 2. What is the purpose of the secret/public key?

• For each individual user, the secret key helps to create a token
• The public key is used to validate the token generated by passing in the request headers

Step - 3. How to generate the token?

• The User / Store has to generate the token(JWT) using the secret key

Python

**jwt.encode(payload, JWT_SECRET, JWT_ALGORITHM)**
# Payload - Data to be passed - If no data to be passed - payload will be {}
#JWT_SECRET - Secret key from the account
#JWT_ALGORITHM - HS256

JavaScript

import jwtEncode from '<https://cdn.jsdelivr.net/npm/[email protected]/+esm>';

const secret = 'VQB Private API key / JWT_SECRET';
const data = {};
const jwt = jwtEncode(data, secret);

console.log(jwt);

STEP - 4. How can you access VQB data - API endpoints?