Introduction

<aside> 🔗 Base URL for endpoints: https://workapp.store/api/v1

</aside>

# Required headers & auth: 
{
   'Content-Type': 'application/json',
   'Authorization': 'Bearer **<YOUR_API_KEY>**',
}

# Default success response have **2xx** code and structure:
{
   'ok': true,
   'data': {...},
}

# Default error response have **4xx or 5xx** code and structure:
{
   'ok': false,
   'error': str,
}

# Payload often have default values, None means that parametr is unnecessary:
payload = {
    'ids': list[int] = None,   # unnecessary parametr, default is empty
    'name': str = None,   # unnecessary parametr, default is empty
    'store': int = None,   # unnecessary parametr, default is empty
    'banned': bool = None,   # unnecessary parametr, default is empty
    'page_size': int = 500,   # unnecessary parametr, default is 500
}

Applications

Add - POST /app/add/

Archive - POST /app/archive/

List - GET /app/list/

Keywords

Add - POST /keyword/add/

List - GET /keyword/list/

Orders

Save - POST /order/save/

Schedule - POST /order/schedule/

Start - POST /order/start/

Pause - POST /order/pause/

Resume - POST /order/resume/

Cancel - POST /order/cancel/

Refund - POST /order/refund/

Archive - POST /order/archive/

List - GET /order/list/

Transactions

Balance - GET /transaction/balance/

List - GET /transaction/list/

Enums

Store

Install Strategies

Rate Strategies

Order Statuses

Transaction Types

Country Codes

Python 3.11 implementation example