Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Offerwall

Offerwall Android SDK

Offerwall iOS SDK

Offerwall Unity SDK

Unity Offerwall

Tapjoy Offerwall
​
​
Getting Started
  • Access the Tapjoy Offerwall monetization dashboard
  • Get started with Offerwall
  • Promoting Offerwall in Unity Ads
  • App setup
Dashboard
  • AB testing
  • Currency sales
  • Exchange rates
  • Messaging
  • Offerwall cards
  • Placements
  • Publisher customer service tool
  • Targeting
  • Metrics reference
Optimization
  • Monetization strategy planning
APIs
  • API authentication
  • Reporting API publisher
  • Reporting API best practices
  • Content management
  • User level revenue API overview
Virtual Currency
  • Virtual currency overview
  • Self-managed currency
  • Tapjoy-managed currency
  • Troubleshoot callback failures
Other
  • Offerwall Monetization Dashboard user roles and permissions
  • Troubleshooting
  • App privacy - iOS
  • Data safety - Android
  • FAQs
  1. Grow your game
  3. Unity Offerwall
  5. Offerwall monetization

API Authentication

Authenticate your API requests with the Tapjoy Offerwall API to gain authorized access to manage user engagement and monetization data.
Read time 2 minutes
Last updated 2 months ago

Requesting access

Requests are authenticated using a standard two-legged OAuth2 flow: an 
access_token
is requested using an encoded API Key, and the resulting 
access_token
is used to authenticate against future requests.
You can find your API key in the LTV Dashboard by selecting an App > Settings > App Settings > Scroll down > API Keys.
The marketing API key displayed in the Offerwall dashboard.
Access tokens have a 1-hour lifetime and cannot be refreshed. When a token expires, you must request a new one with your Reporting API Key/Marketing API Key.
To request an access token you must send a POST request with an Authorization header using your API Key. If the credentials are valid the response will include an access token and the number of seconds until the token expires.

Example request

The following examples show how to request an access token using raw HTTP, curl, and Ruby.
POST /v1/oauth2/token Host: api.tapjoy.com Authorization: Basic <API Key> Accept: application/json
curl -H "Authorization: Basic <API Key>" -X POST https://api.tapjoy.com/v1/oauth2/token
require 'json'require 'net/https'access_token = "<OAuth Token>"query = <<~ENDquery {  user {    firstName  }}ENDjson = JSON.dump({query: query})http = Net::HTTP.new('api.tapjoy.com', 443)http.use_ssl = truerequest = Net::HTTP::Post.new('/graphql')request['Authorization'] = "Bearer #{access_token}"request.body = jsonresponse = http.request(request)result = JSON.parse(response.body)data = result['data']errors = result['errors']

Successful response

A successful request returns a 200 status with an access token and its expiry duration in seconds.
status 200 { "access_token": "token_string", "token_type": "bearer", "expires_in": 3600, "refresh_token": null }

Unsuccessful response

If the API Key is invalid or missing, the request returns a 401 status.
status 401{ "error": "Unauthorized" }

Using the access token

Once you have an 
access_token
, requests can be made to the API. The 
access_token
should be sent with every request in the Authorization header with a type of "Bearer". If the 
access_token
has expired or does not exist the response will have a status of 401 Unauthorized.

Example request

The following example shows the required headers for an authenticated API request.
POST /v4/audiences Host: api.tapjoy.com Authorization: Bearer <token_string> Accept: application/json

Missing or invalid token response

If the access token is missing or has expired, the request returns a 401 status.
status 401 { "error": "Unauthorized" }
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Requesting access

      • Example request

      • Successful response

      • Unsuccessful response

    • Using the access token

      • Example request

      • Missing or invalid token response

Report a problem with this page