API documentation

Version 2.0

API is an acronym for application programming interface and it allows you to communicate with our CDN77 service through JSON (JavaScript Object Notation).

Benefits

CDN77 API allows you to do a wide range of commands and tasks from an external script or server. We provide our clients with all the necessary documentation including detailed examples on how to execute various requests. You’ll be able to easily manage your CDN resources by getting programming level access to various areas of our service.

Support

Have questions? Check out some of the numerous articles on API throughout the rest of our Knowledge Base. If you can’t find what you’re looking for or you're stuck, just contact our support department and we’ll help you out.

API includes the most wanted features:

Account editing
Billing & Invoicing
CDN resources creating / editing
CDN Storage
Logs & Reports

Is your POST request to our API failing? Please check that your POST request header Content-Type is set to value x-www-form-urlencoded.

Parameters & HTTP method

At the beginning of each section there is a list of available parameters and required HTTP methods to use (either get or post).

Standard response parameters:

status: [ ok | error ]

description: [ Request was successful. | Request was not successful. | Custom ]

errors: [ array (parameter name => error description) | Not sent when there are no errors ]

customObject: [ object ]

Notes to standard response

Example of a custom description: Purge is accepted. It can take a few minutes to process the request on all datacentres.

When there are no errors, the errors object is not sent.

Examples of custom objects: account, billingOverview. Custom objects parameters and values are described in each method's return value.

Examples of responses


# successful request
{"status": "ok", "description": "Request was successful."}

# not successful request due to wrong login && passwd
{"status": "error", "description": "Authentication failed. Please, login again or contact our support."}

# not successful request with error for parameter email
{"status": "error", "description": "Request was not successful.", "errors": {"email": "email is required.", "password": "password is required."}}

Have suggestions to improve our documentation?

If you have suggestions on how to improve our documentation, feel free to contact us at support@cdn77.com. Drop us a line even when there is something confusing in our documentation.

Available objects

Account

Manage your CDN77 acount.

Billing

Manage your billing.

Billing Overview

Obtain a summary of your billing information that includes your number of SSL certificates, yearly SSL fee, estimated bandwidth usage, estimated lifespan of your credit, credit expiration and remaining credit.

Billing Country

View countries available to be set in the billing section.

CDN Resources

Create, manage and administer your HTTP CDN Resources.

Data Center Location

Manage the data center locations for your CDN Resources.

Data Management

Manage your cached data by purging and prefetching your files. In addition to 2000 URLs per request, users are limited to 20 purge/prefetch requests per 5 minutes. This limitation is per-user and not per-system.

In case you need to work with filenames with special characters, use their encoded version (see example section at purge method.

Purge and prefetch requests are proceeded in queues. Please be aware that receiving a successful response from these methods doesn't mean the purge/prefetch itself was successful. It means that the request was successfully accepted to our queue. Don't forget to use the following methods from our Data Queue section to retrieve detailed information about the request.

Data Queue

When calling a purge or prefetch request, we monitor whether the sent URL has been accepted and sent to our queue. We are not able to provide you with information on whether the purge or prefetch itself was successful. The data queue method is here to help you go through the purge and prefetch results.