INTEGRATION WITH BOGOS API

This page provides an overview of the key requirements for integration with the BOGOS app via the BOGOS API. It is recommended to read this page thoroughly before proceeding to the next sections

1. Requirements

1.1. BOGOS app installed

Install BOGOS app: https://apps.shopify.com/freegifts

Please refer to BOGOS' Demo store for all features demo: Demo store

If you need integration in a development environment, contact BOGOS via live chat or email at [e-mail]

1.2. Endpoint API

https://api.bogos.io/

1.3. Middleware

• Authorization:

You must add the following header to all API requests:

{
   authorization: "Bearer $token",
   verify: ""; //Contact BOGOS for help
}

• Generate token:

You can generate the $token using either jsonwebtoken or jwt-encode. Here’s an example:

const jwt = require('jsonwebtoken');

const payload = {
  integration: "" //Contact BOGOS for help
};

const secretKey = 'secret_key'; //contact bogos for secret_key
const token = jwt.sign(payload, secretKey, {expiresIn: 120})

1.4. Hide gift product (cloned product)

You can use tag (bogos-gift) or handle (*-sca_clone_freegift) to hide the cloned product.

1.5 Default type

You must pay attention to this section because it's the data types when making API calls. Please review the Default Type in the documentation for details.

2. Next step

Once you’ve thoroughly reviewed the requirements, proceed to the documentation to implement the desired features. The BOGOS API includes 2 main types of offers: Gift Offer and Bundle Offer. Follow the step-by-step guides in each section to integrate your system with BOGOS.3