Getting started
API Endpoint http://pocket.droidoxy.com/
This API provides programmatic access to Pocket Rewards Script. Retrieve a user info, user balance, user transactions, list of available offerwalls, list of available redeem options or even authenticate the user with username/email and password.
To use this API, you need an API Endpoint. Which is nothing but your Server URL on which the Pocket Script has been installed. Please open a ticket at www.droidoxy.com/support if you need any help.
Get Offerwalls
# Here is a curl example
curl \
-X POST http://pocket.droidoxy.com/api/v1/app.OfferWalls.php
To get Offerwalls - The Featured Items, you need to make a call to the following url :
http://pocket.droidoxy.com/api/v1/app.OfferWalls.php
Result example :
{
"error": false,
"error_code": 0,
"offerwalls": [
{
"offer_id": "1",
"offer_title": "Daily Checkin",
"offer_subtitle": "open App daily and get 25 Points",
"offer_url": "",
"offer_type": "checkin",
"offer_points": "25",
"offer_featured": true,
"offer_thumbnail": "ic_checkin.png",
"offer_position": "1",
"offer_status": "Active"
},
{
"offer_id": "11",
"offer_title": "AdGateMedia",
"offer_subtitle": "Install Apps To Earn Points",
"offer_url": "",
"offer_type": "adgatemedia",
"offer_points": "0",
"offer_featured": true,
"offer_thumbnail": "ic_adgate.png",
"offer_position": "11",
"offer_status": "Active"
},
{
"offer_id": "3",
"offer_title": "Refer & Earn",
"offer_subtitle": "Refer Friends and Get Points",
"offer_url": "",
"offer_type": "refer",
"offer_points": "100",
"offer_featured": true,
"offer_thumbnail": "ic_fireworks.png",
"offer_position": "3",
"offer_status": "Active"
},
{
"offer_id": "4",
"offer_title": "Transactions",
"offer_subtitle": "View All your Transactions",
"offer_url": "",
"offer_type": "transactions",
"offer_points": "0",
"offer_featured": true,
"offer_thumbnail": "ic_transactions.png",
"offer_position": "4",
"offer_status": "Active"
},
{
"offer_id": "5",
"offer_title": "Redeem",
"offer_subtitle": "Turn your Points into cash",
"offer_url": "",
"offer_type": "redeem",
"offer_points": "0",
"offer_featured": true,
"offer_thumbnail": "ic_redeem.png",
"offer_position": "5",
"offer_status": "Active"
},
{
"offer_id": "6",
"offer_title": "Instructions",
"offer_subtitle": "How to Earn Points",
"offer_url": "",
"offer_type": "instructions",
"offer_points": "0",
"offer_featured": true,
"offer_thumbnail": "ic_info.png",
"offer_position": "6",
"offer_status": "Disabled"
},
{
"offer_id": "9",
"offer_title": "About Us",
"offer_subtitle": "Advertise with Us",
"offer_url": "",
"offer_type": "about",
"offer_points": "0",
"offer_featured": true,
"offer_thumbnail": "ic_about.png",
"offer_position": "9",
"offer_status": "Disabled"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
-- | -- | -- |
Get Payouts
# Here is a curl example
curl \
-X POST http://pocket.droidoxy.com/api/v1/app.Payouts.php
To get Payouts - The Redeem options, you need to make a call to the following url :
http://pocket.droidoxy.com/api/v1/app.Payouts.php
Result example :
{
"error": false,
"error_code": 0,
"payouts": [
{
"payout_id": "1",
"payout_title": "Paypal",
"payout_subtitle": "1000 Points = $1 USD",
"payout_message": "Enter your Paypal Email :",
"payout_amount": "$1 USD",
"payout_pointsRequired": "1000",
"payout_thumbnail": "paypal_icon.png",
"payout_status": "Active"
},
{
"payout_id": "2",
"payout_title": "PayTm",
"payout_subtitle": "1000 Points = 100 INR",
"payout_message": "Enter your Paytm Mobile Number :",
"payout_amount": "100 INR",
"payout_pointsRequired": "1000",
"payout_thumbnail": "paytm_icon.png",
"payout_status": "Active"
},
{
"payout_id": "3",
"payout_title": "Google Play",
"payout_subtitle": "9000 Points = $10 USD",
"payout_message": "Enter your Google Playstore Email :",
"payout_amount": "$10 USD",
"payout_pointsRequired": "9000",
"payout_thumbnail": "googleplay_icon.png",
"payout_status": "Active"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
-- | -- | -- |
User Authentication
# Here is a curl example
curl \
-X POST http://pocket.droidoxy.com/api/v1/account.signIn.php \
-F 'clientId=1' \
-F 'username=johndoe' \
-F 'password=123456'
To get the accessToken of the user, you need to authenticate the user by making a call to the following url :
http://pocket.droidoxy.com/api/v1/account.signIn.php
The accessToken is required to get user info, user balance and all the data of the user. The accessToken is a string of characters that is assigned for the current session of the user
Result example :
{
"error": false,
"error_code": 0,
"accessToken": "40b08fea2a2f800ec2ea702cf23a0406",
"accountId": "26",
"account": [
{
"error": false,
"error_code": 0,
"id": "26",
"last_access": "1521317976",
"last_ip_addr": "183.82.253.157",
"gcm": "NoqSBlhxN1RLpBQgdSi4fkO3zp8wswL4slIMQgHb3KLEuw3m_X",
"state": "0",
"fullname": "John Doe",
"username": "johndoe",
"email": "johndoe@droidoxy.com",
"regtime": "1521317976",
"ip_addr": "106.200.148.244",
"mobile": "",
"points": "260",
"refer": "CKRSM0",
"refered": "0"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
clientId | int | Id of the client (eg. 1) |
username | string | username of the user |
password | string | password of the user |
Get User Balance
# Here is a curl example
curl \
-X POST http://pocket.droidoxy.com/api/v1/account.Balance.php \
-F 'clientId=1' \
-F 'accountId=26' \
-F 'accessToken=40b08fea2a2f800ec2ea702cf23a0406' \
-F 'user=johndoe'
To get the current points balance of the user, you need to make a call to the following url :
http://pocket.droidoxy.com/api/v1/account.Balance.php
Result example :
{
"error": false,
"error_code": 0,
"user_balance": "260"
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
clientId | int | Id of the client (eg. 1) |
accountId | string | Id of the user |
accessToken | string | access token for the current session of the user |
user | string | username of the user |
Get User Transations
# Here is a curl example
curl \
-X POST http://pocket.droidoxy.com/api/v1/account.Transactions.php \
-F 'clientId=1' \
-F 'accountId=26' \
-F 'accessToken=40b08fea2a2f800ec2ea702cf23a0406' \
-F 'user=johndoe'
To get all transactions of the user, you need to make a call to the following url :
http://pocket.droidoxy.com/api/v1/account.Transactions.php
Result example :
{
"error": false,
"error_code": 0,
"user": "johndoe",
"transactions": [
{
"tn_id": "PCKTCR010235",
"tn_type": "cr",
"tn_name": "Daily Checkin Credit",
"tn_points": "25",
"tn_date": "18 Mar 2018",
"tn_status": "1"
},
{
"tn_id": "PCKTCR010221",
"tn_type": "cr",
"tn_name": "Spin & Win Credit",
"tn_points": "25",
"tn_date": "19 Mar 2018",
"tn_status": "1"
},
{
"tn_id": "PCKTCR010221",
"tn_type": "cr",
"tn_name": "AdMantum Offerwall Credit",
"tn_points": "25",
"tn_date": "19 Mar 2018",
"tn_status": "1"
},
{
"tn_id": "PCKTDB0102",
"tn_type": "db",
"tn_name": "$1 USD Paypal",
"tn_points": "1000",
"tn_date": "11 Oct 2018",
"tn_status": "1"
}
]
}
QUERY PARAMETERS
Field | Type | Description |
---|---|---|
clientId | int | Id of the client (eg. 1) |
accountId | string | Id of the user |
accessToken | string | access token for the current session of the user |
user | string | username of the user |
Error Codes
The Pocket API uses the following error codes:
Error Code | Meaning |
---|---|
100 | Error client Id. This error appears when you don't pass mandatory parameter clientId |
101 | Error authorization. This error appears when you don't pass mandatory parameter accessToken |