> For the complete documentation index, see [llms.txt](https://bogos-api-integration.gitbook.io/bogos-api-integration/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bogos-api-integration.gitbook.io/bogos-api-integration/overview.md).

# Overview

BOGOS provides two integration methods. Choose the one that best fits your technical needs and level of customization:

1. [**Integration with BOGOS API**](/bogos-api-integration/integration-steps.md)\
   You call the BOGOS REST API directly and render every offer yourself. Best when you want advanced customization and full control over the response data.
2. [**Integration with BOGOS JS/SDK**](/bogos-api-integration/bogos-js-sdk.md)\
   You load the BOGOS script, which renders the offers for you. Best when you want to set up many offer types quickly with minimal code.

## Which one should I use?

|                        | BOGOS API                               | BOGOS JS/SDK                            |
| ---------------------- | --------------------------------------- | --------------------------------------- |
| **Integration effort** | Higher — you build the UI               | Lower — drop-in script                  |
| **Rendering**          | You render every offer                  | BOGOS renders offers for you            |
| **Customization**      | Full control over data and UI           | UI provided; customize via events & CSS |
| **Offers covered**     | Gift, Bundle, Upsell, Discount, Booster | Gift, Bundle, Upsell, Discount, Booster |
| **Authentication**     | JWT token + `verify` header             | `data-bogos-key` on the script tag      |
| **Best for**           | Headless stores needing full control    | Quick setup across many offer types     |

```mermaid
flowchart TD
    A{Want BOGOS to render<br/>the offer UI for you?} -- Yes --> B[BOGOS JS/SDK]
    A -- No, I need full control --> C[BOGOS API]
    B --> D[Load the script + dispatch events]
    C --> E[Call the REST API + render yourself]
```

{% hint style="info" %}
New here? Start with the [Quickstart](/bogos-api-integration/quickstart.md). Need more information? Contact us via live chat on [BOGOS: Free Gift](https://apps.shopify.com/freegifts) or email <help@bogos.io>.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bogos-api-integration.gitbook.io/bogos-api-integration/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.