Справка

API функции

Основы

Запросы

URL для API запросов http://pixcp.ahcdn.com/api/[имя модуля]/[имя действия]/

В большинстве случаев вам нужно передавать параметры. Вы можете использовать GET или POST методы - разницы нет.

Обратите внимание, что в случае передачи данных с одинаковыми именами через GET и POST одновременно - API будет работать со значением переданным через POST.

Лимит запросов - 100 в минуту, 600 в час, 2500 в сутки.

Авторизация

При создании запроса к API вам нужно идентифицировать себя при помощи Basic HTTP Authorization.

Нет разницы между этой авторизацией и входом в систему через форму в админке. Таким образом логины и пароли - те же, что для обычного входа в админку.

Простейший пример передачи данных о пользователе для HTTP Authorization в строке URL:

http://user:password@pixcp.ahcdn.com/api/pixcdn/action
Основные параметры
respond
  • plaintext - ответ API будет выдан простым текстом без каких либо кодирований
  • json - ответ API будет закодирован в JSON формат
  • xml (по-умолчанию) - ответ API будет представлен в виде XML
Пример выполнения запроса к API на языке SHELL
LOGIN=user PASS=password AUTH=`echo -n "$LOGIN:$PASS" | base64 -e` wget -qO - --header='Accept-Encoding: *,gzip' --header="Authorization: Basic $AUTH" 'http://pixcp.ahcdn.com/api/pixcdn/clear_cache?respond=plaintext&id[]=123&id[]=345'

Очистка кэша

Название действия

clear_cache

Принимаемые параметры
id (обязательный)
Это ID источника для которого вы хотите очистить кэш. Его можно посмотреть на странице списка источников. Параметр может быть массивом или еденичным значением.
Примеры запросов
http://pixcp.ahcdn.com/api/pixcdn/clear_cache?id=123 http://pixcp.ahcdn.com/api/pixcdn/clear_cache?id[]=123&id[]=345&id[]=678

Массовое удаление

Название действия

bulkdelete

Принимаемые параметры
source (обязательный)
Это ID источника для которого нужно удалить файлы. Его можно посмотреть на странице списка источников. Параметр может быть только еденичным значением.
bulk (опционально обязательный)
Это список файлов и/или директорий, которые нужно удалить. Значения разделены переводом строки (\n).
url (опционально обязательный)
URL текстового файла доступного через интернет. Файл должен содержать список файлов и/или директорий, которые нужно удалить. Значения разделены переводом строки (\n).
bulkfile ЗАГРУЗКА (опционально обязательный)
Имя параметра для загружаемого вами файла. Файл должен содержать список файлов и/или директорий, которые нужно удалить. Значения разделены переводом строки (\n).
type
  • files (по-умолчанию) - система удалит только файлы из списка. Если в списке будет указана директория - она будет проигнорирована.
  • directories - система удалит и файлы и директории.

ВНИМАНИЕ! Вам нужно указывать только один из "опционально обязательных" параметров.

Примеры запросов
http://pixcp.ahcdn.com/api/pixcdn/bulkdelete?source=123&type=directories&bulk=path/filename http://pixcp.ahcdn.com/api/pixcdn/bulkdelete?source=123&type=directories&bulk=path/filename1%0Apath/filename2%0Apath/filename3

RSYNC хранилища

Название действия

rsync

Принимаемые параметры
id (обязательный)
Это ID хранилища для которого вы хотите выполнить rsync. Его можно посмотреть на странице списка хранилищ. Параметр может быть массивом или еденичным значением.
Примеры запросов
http://pixcp.ahcdn.com/api/pixcdn/rsync?id=123 http://pixcp.ahcdn.com/api/pixcdn/rsync?id[]=123&id[]=345&id[]=678

RSYNC хранилища (статус выполнения)

Название действия

rsync_status

Принимаемые параметры
id (обязательный)
Это ID хранилища для которого вы хотите проверить статус выполнения rsync. Его можно посмотреть на странице списка хранилищ. Параметр может быть массивом или еденичным значением.
Примеры запросов
http://pixcp.ahcdn.com/api/pixcdn/rsync_status?id=123 http://pixcp.ahcdn.com/api/pixcdn/rsync_status?id[]=123&id[]=345&id[]=678

Создание источника.

Для того чтобы подключить сайт в CDN нужно зайти в админку (http://pixcp.ahcdn.com/) в раздел Источники (http://pixcp.ahcdn.com/ru/sources) и нажать кнопку "добавить источник".

Источники

В поле "Источник*:" нужно ввести домен, с которого наша система будет импортировать изображения или любые другие статические файлы в наш CDN (без http:// в начале и / в конце - только домен).

Если Вы желаете использовать для отдачи с CDN свой домен, то его необходимо указать в поле "CNAME" (для этого домена Вам нужно создать dns-запись, указав домен из поля "домен доступности" в качестве CNAME.

Для активации антихотлинка нужно указать хотябы один "REFERER:". При включенной функции антихотлинка файлы отдаются только в том случае, если referer один из разрешённых, пустой или заблокированный.

Создание источника

Когда статус источника сменится с "new" на "active" его можно использовать.

Например Вы указали example.com как источник, cdn.example.com - как CNAME (и создали соответственно CNAME запись в DNS). Тогда для того, чтобы начать показывать изображения с CDN Вам нужно изменить url изображений в тэге img.

Для файла

<img src='/img/1.png' />

это будет выглядеть так:

<img src='http://cdn.example.com/img/1.png' />

Очистка кэша и массовое удаление файлов.

Для выполнения очистки кэша нужно на странице "Источники" отметить источник и нажать на кнопку "Очистить кэш".

Для массового удаления файлов предусмотрена специальная функция ("Массовое удаление файлов" в меню). Из выпадающего списка выберите источник, затем тип (files или directories, если будет выбрано directories то указание файлов в списке также допустимо). Имена файлов в списке разделяются переводом строки, пути должны быть указаны относительные. Например, если нужно удалить из кэша http://cdn.example.comimages/1.png и http://cdn.example.comimages/2.png укажите в списке:

img/1.png img/2.png
Массовое удаление файлов