Ad endpoints

Endpoints relating to ads

How to format urls:

• Callback: https://ads.luaauth.com/verify/:CALLBACK_ID
• Postback: https://ads.luaauth.com/postback/:POSTBACK_ID

Getting provider info

GET /ads/providers

Response:

success

{
  "success": true,
  "providers": {
    "PROVIDER_NAME": [{
      "id": "SETTING_ID",
      "name": "SETTING_NAME",
      "type": "toggle" OR "text" OR "info",
      "info": "SETTING_INFO",
      "needed_for": [ "SETTING_ID" ] OR null,
      "hide_unless": [ "SETTING_ID" ] OR null,
    }]
  }
}

Creating a new system

POST /ads/systems/new

Payload:

Key	Type	Required	Default
project_id	`String`	`True`
name	`String`	`True`
key_duration	`Number`	`False`	`86400000`
max_keys	`Number`	`False`	`1`
allow_extending	`Boolean`	`False`	`True`
max_duration	`Number`	`False`	`604800000`

Response:

success Error

{
  "success": true,
  "system_id": "SYSTEM_ID"
}

Code	Message
0	max systems reached
1	account expired
2	cannot use this project
3	max duration should be more than duration

Getting systems

GET /ads/systems

Response:

success

{
  "success": true,
  "systems": [{
    "id": "SYSTEM_ID",
    "project_id": "PROJECT_ID",
    "name": "SYSTEM_NAME",
    "key_duration": 86400000,
    "max_keys": 1,
    "allow_extending": true,
    "max_duration": 604800000
  }]
}

Getting a system

GET /ads/systems/:system_id

Params:

Key	Description
system_id	The systems id

Response:

success

{
  "success": true,
  "system": {
    "id": "SYSTEM_ID",
    "project_id": "PROJECT_ID",
    "name": "SYSTEM_NAME",
    "key_duration": 86400000,
    "max_keys": 1,
    "allow_extending": true,
    "max_duration": 604800000
  }
}

Editing a system

POST /ads/systems/:system_id/edit

Params:

Key	Description
system_id	The systems id

Payload:

Key	Type	Required
project_id	`String`	`False`
name	`String`	`False`
key_duration	`Number`	`False`
max_keys	`Number`	`False`
allow_extending	`Boolean`	`False`
max_duration	`Number`	`False`

Response:

success Error

{ "success": true }

Code	Message
0	account expired
1	cannot use this project
2	cannot edit nothing
3	max duration should be more than duration

Changing a systems custom url

POST /ads/systems/:system_id/url

A-Z, a-z, 0-9 and - are the only characters allowed in the custom url

Params:

Key	Description
system_id	The systems id

Payload:

Key	Type	Required
url	`String`	`False`

Response:

success Error

{ "success": true }

Code	Message
0	account expired
1	tier does not allow custom ad urls
2	custom url already taken

Deleting a system

POST /ads/systems/:system_id/remove

Params:

Key	Description
system_id	The systems id

Response:

success

{ "success": true }

Getting checkpoints

GET /ads/systems/:system_id/checkpoints

Params:

Key	Description
system_id	The systems id

Response:

success

{
  "success": true,
  "checkpoints": [{
    "id": "CHECKPOINT_ID",
    "system_id": "SYSTEM_ID",
    "name": "CHECKPOINT_NAME",
    "url": "PROVIDER_URL",
    "idx": 0,
    "provider": "linkvertise" OR "lootlabs" OR "work.ink",
    "provider_data": { "SETTING_ID": "SETTING_VALUE" },
    "callback_id": "CALLBACK_ID",
    "total_completed": 0,
    "total_failed": 0,
    "average_time_taken": 0 // unix ms
  }]
}

Preparing a new checkpoint

POST /ads/systems/:system_id/checkpoints/prepare

Params:

Key	Description
system_id	The systems id

Response:

success

{
  "success": true,
  "id": "CHECKPOINT_ID",
  "callback_id": "CALLBACK_ID"
}

Creating a new checkpoint

GET /ads/systems/:system_id/checkpoints/new

You must prepare a checkpoint before being able to create one

Params:

Key	Description
system_id	The systems id

Payload:

Key	Type	Options	Required
name	`String`		`True`
url	`String`		`True`
provider	`Enum`	`linkvertise` OR `lootlabs` OR `work.ink`	`True`
provider_data	`JSON`		`True`

Response:

success Error

{
  "success": true,
  "checkpoint_id": "CHECKPOINT_ID",
  "postback_id": "POSTBACK_ID" OR null
}

Code	Messages
0	`provider data SETTING_ID cannot be changed` OR `provider data SETTING_ID cannot be null` OR `provider data SETTING_ID required for SETTING_IDS` OR `provider data SETTING_ID is not a TYPE`
1	no checkpoints prepared yet
2	max checkpoints reached
3	account expired
4	max checkpoints reached for this system
5	invalid url provided

Getting a checkpoint

GET /ads/checkpoints/:checkpoint_id

Params:

Key	Description
checkpoint_id	The checkpoints id

Response:

success

{
  "success": true,
  "checkpoint": {
    "id": "CHECKPOINT_ID",
    "system_id": "SYSTEM_ID",
    "name": "CHECKPOINT_NAME",
    "url": "PROVIDER_URL",
    "idx": 0,
    "provider": "linkvertise" OR "lootlabs" OR "work.ink",
    "provider_data": { "SETTING_ID": "SETTING_VALUE" },
    "callback_id": "CALLBACK_ID",
    "total_completed": 0,
    "total_failed": 0,
    "average_time_taken": 0 // unix ms
  }
}

Editing a checkpoint

POST /ads/checkpoints/:checkpoint_id/edit

Params:

Key	Description
checkpoint_id	The checkpoints id

Payload:

Key	Type	Options	Required
name	`String`		`False`
url	`String`		`False`
provider	`Enum`	`linkvertise` OR `lootlabs` OR `work.ink`	`False`
provider_data	`JSON`		`False`

Response:

success Error

{
  "success": true,
  "postback_id": "POSTBACK_ID" OR null
}

Code	Messages
0	`provider data SETTING_ID cannot be changed` OR `provider data SETTING_ID cannot be null` OR `provider data SETTING_ID required for SETTING_IDS` OR `provider data SETTING_ID is not a TYPE`
1	account expired
2	invalid url provided
3	cannot edit nothing

Swapping a checkpoint

POST /ads/checkpoints/:checkpoint_id/swap

Params:

Key	Description
checkpoint_id	The checkpoints id

Payload:

Key	Type	Required
index	`Number`	`True`

Response:

success Error

{ "success": true }

Code	Message
0	account expired
1	must give a valid index to swap with

Deleting a checkpoint

POST /ads/checkpoints/:checkpoint_id/remove

Params:

Key	Description
checkpoint_id	The checkpoints id

Response:

success

{ "success": true }

Ad endpoints Getting provider info Creating a new system Getting systems Getting a system Editing a system Changing a systems custom url Deleting a system Getting checkpoints Preparing a new checkpoint Creating a new checkpoint Getting a checkpoint Editing a checkpoint Swapping a checkpoint Deleting a checkpoint