> For the complete documentation index, see [llms.txt](https://docs.ayetstudios.com/v/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ayetstudios.com/v/product-docs/offerwall/api-integrations/offerwall-api.md).

# 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="/pages/W7CE6bNya8L7RoaXXY21" %}
[Dashboard Setup](/v/product-docs/dashboard-setup.md)
{% 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="/pages/5sxVWIW1fto5Mmv1JxeJ" %}
[Callbacks & Testing](/v/product-docs/callbacks-and-testing.md)
{% endcontent-ref %}