API Reference

Integrate Poremi services into your backend. Test endpoints directly with your API key.

🔑
Your API Key
Log in to see your API key

This key will be pre-filled in all "Try it out" panels below.

Authentication

Headers required for all requests:

x-api-key: sk_live_your-api-key
x-miniapp-id: your-miniapp-slug

Endpoints

Auth
POST/v1/auth/loginLogin and receive tokensView →
POST/v1/auth/registerRegister new partner account
POST/v1/auth/refreshRefresh access token
Miniapp
GET/v1/miniapps/:idGet miniapp infoView →
GET/v1/miniapps/:id/api-keysList API keys
POST/v1/miniapps/:id/api-keysIssue new API key
Ad Units
GET/v1/ad-unitsList ad units
POST/v1/ad-unitsCreate ad unit
Credits
GET/v1/credits/balanceGet credit balance
GET/v1/credits/transactionsList transactions
Settlements
GET/v1/settlementsList settlements
GET/v1/settlements/:idGet settlement detail
POST/v1/settlements/:id/select-methodSelect payout method
Payout Methods
GET/v1/payout-methodsList payout methods
POST/v1/payout-methodsAdd payout method