# Offerwall API

## Eligible Placement & AdSlot Combinations <a href="#eligible-placement-and-adslot-combinations" id="eligible-placement-and-adslot-combinations"></a>

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Offerwall API integration.

| Placement Type | AdSlot Type   | Eligible Integration Type |
| -------------- | ------------- | ------------------------- |
| Android App    | Offerwall API | Offerwall API             |
| iOS App        | Offerwall API | Offerwall API             |
| Website        | Offerwall API | Offerwall API             |

{% hint style="danger" %}
If you integrate the Offerwall API while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to make correct API requests.
{% endhint %}

## Getting Started

Before you start with the integration, make sure you:

* [x] Created an Account
* [x] Added a Placement
* [x] Added an AdSlot

You will find more details here:

{% content-ref url="../../dashboard-setup" %}
[dashboard-setup](https://docs.ayetstudios.com/v/product-docs/dashboard-setup)
{% endcontent-ref %}

## Technical Offerwall API Documentation <a href="#technical-offerwall-api-documentation" id="technical-offerwall-api-documentation"></a>

For API Calls, all offers matching the parameters provided will be returned and can be displayed to the user.

The Offerwall API supports both server and client-side calls.

Follow the link below to get to the detailed technical documentation.

{% embed url="<https://www.ayetstudios.com/openapi/publisher-doc#tag/Offerwall-API>" %}

## Conversion Callbacks & Currency Handling <a href="#conversion-callbacks-and-currency-handling" id="conversion-callbacks-and-currency-handling"></a>

Learn about:

* Setting up callbacks
* IP Whitelists
* Securing callbacks using HMAC Security Hash
* Testing callbacks

Click on the link below:

{% content-ref url="../../callbacks-and-testing" %}
[callbacks-and-testing](https://docs.ayetstudios.com/v/product-docs/callbacks-and-testing)
{% endcontent-ref %}


---

# Agent Instructions: 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:

```
GET https://docs.ayetstudios.com/v/product-docs/offerwall/api-integrations/offerwall-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.