API Details and Overview Hackers don't read.


Live Usage

The Live API is available at:
https://api.pagely.com/v1/

 

Sandbox Testing

The sandbox API is available at:
https://sandbox-api.pagely.com/v1/


API-KEY Security

ATTENTION This is not an open API. Keys will be provided to partners by page.ly and the partner is responsible for keeping this key secret and safe. All requests to the API are logged and the partner is solely responsible for all usage and ramifications of such usage of their API key. Partners may reset their API key or create additional keys for other application via our Photon interface as needed.

Legal

In English: We do not provide a warranty or guarantee of business effectiveness, use at your own risk, and you agree to hold us harmless for any real or perceived injustice. However you agree that we will hold you liable and accountable for all actions using your API key.

Useful Examples

Here

Usage Guidelines

The API is for partners to integrate pagely into their existing system. A typical scenario would be a plugin company adding hosting as an option at checkout. Through the API and our system, a hosting account would be created for that user, with the chosen plugin enabled and ready to go at login.  Don’t be shady and all should be fine. Please be a good citizen and submit bugs here.

Terminology: Partner = Reseller and Reseller != Partner. While this API is used internally to manage accounts and  resellers, the external usage is limited only to partners, but the field ids and labels are the same. Confusing yes. So all partners are technically resellers, but only a very small number of resellers have access to this API and would be called Partners.

View v1 Endpoints

Requests

This is RESTful API. And while we did our best, it may not adhere to some golden standard in all cases.

  • GET : Retrieves object(s)
  • PUT: Creates an object
  • POST: Updates an object
  • DELETE: Removes an object

Hello World

curl -H "X-API-KEY:key" https://api.pagely.com/v1/go/hello

Update a promocode change the value to 50

curl -X POST -H "X-API-KEY:key" -d "id=216&value=50" https://api.pagely.com/v1/bill_promocodes/single

Responses

Responses are JSON and will vary slightly in structure depending on the type of call made. Result:2 is considered a good/valid/success response. Result:3 will be some sort of error.

Response Template

GET: /all
	response:
	{
		'result'    => 2,
		'count'     => count($objects),
		'limit'     => (int)$pagination['limit'],
		'offset'    => (int)$pagination['offset'],
		'objects'   => $objects
	}

GET /single
	response:
	{ object }

POST, PUT, DELETE: /single
	response:
	{
		'result'    => (2 = succcess, 3 = error), 
		'id'        => 1234, 
		'message'   => 'Message about what was done or the error'
      'errors'    => {  (NOT ALWAYS PRESENT) 
        'key' => 'specific error message about the submitted value',
      }
	}

Hello World decoded PHP response

stdClass Object
(
    [result] => 2
    [message] => Valid Key
    [wisdom] => There are three sides to any argument: your side, my side and the right side.
)