> 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/static-api.md).

# Static API

The Static API is recommended only for special integrations, because not all campaigns are available without more sophisticated device match.

{% hint style="success" %}
If integrated, it should be called each 15-30 minutes to make sure our campaigns are still available, did not run into daily caps or changed targeting / bid.
{% endhint %}

{% hint style="danger" %}
The "Static API key" for requests is adslot specific and available in the adslot details once approved by your account manager.
{% endhint %}

## 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 Static API integration.

| Placement Type | AdSlot Type | Eligible Integration Type |
| -------------- | ----------- | ------------------------- |
| Website        | Static API  | Static API                |
| Android App    | Static API  | Static API                |
| iOS App        | Static API  | Static API                |
| API / Network  | Static API  | Static 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 Documentation: Static API <a href="#technical-documentation-static-api" id="technical-documentation-static-api"></a>

API calls return a list of currently running campaigns on our platform which suit your adslot configuration. Can be filtered by additional parameters.

{% hint style="info" %}
**Note:** To pass custom parameters from clicks to conversion callbacks, the tracking\_link parameter in offer objects can be extended with \&custom\_1=... to \&custom\_5=...
{% endhint %}

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

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

## Reward Status API

In order to keep track of user progress, please refer to the Reward Status API.

The Reward Status API provides publishers with detailed information about a user’s reward progress across all campaigns they have interacted with.

Follow the link to learn more about the Reward Status API.

{% embed url="<https://www.ayetstudios.com/openapi/publisher-doc#tag/Reward-Status-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 %}