Кексик

Документация API

Все запросы должны отправляться на адрес https://api.keksik.io/{метод}

Все запросы должны передаваться через метод POST в виде JSON массива. В заголовке Content-type должно передаваться application/json.

Текущая версия API 1. Версия API будет повышаться при изменении полей в старых методах. При добавлении новых полей, а также при добавлении новых методов, версия API НЕ будет повышаться.

Внимание! У API есть ограничения. Суточный лимит запросов - 3000. Не чаще одного запроса в 5 секунд.

PHP

Ниже приведен PHP класс для работы с API. Версия PHP не ниже 7.0.

class Keksik {
	private $group;
	private $token;
	private $v = 1;

	function __construct($group, $token) {
		$this -> group = $group;
		$this -> token = $token;
	}
	public function request($method, $params = []) {
		if (!isset($params['group'])) $params['group'] = $this -> group;
		if (!isset($params['token'])) $params['token'] = $this -> token;
		if (!isset($params['v'])) $params['v'] = $this -> v;

		$ch = curl_init();
		curl_setopt_array($ch, [
			CURLOPT_URL => 'https://api.keksik.io/' . $method,
			CURLOPT_HTTPHEADER => ['Content-type: application/json'],
			CURLOPT_RETURNTRANSFER => true,
			CURLOPT_POST => true,
			CURLOPT_POSTFIELDS => json_encode($params)
		]);
		$response = curl_exec($ch);
		curl_close($ch);

		return json_decode($response, true);
	}
}

C# ASP.NET

Сторонним разработчиком @londonist была реализована библиотека для работы с нашим API для C# ASP.NET. Выражаем благодарность разработчику!

GitHub
NuGet

Python

Сторонним разработчиком @frinyacode была реализована библиотека для работы с нашим API для Python. Выражаем благодарность разработчику!

GitHub
PyPI

Список кодов ошибок и их описание

• 1000 - Неизвестный метод.
• 1001 - Не переданы обязательные параметры.
• 1002 - Переданы некорректные значения для некоторых параметров.
• 1004 - Ошибка авторизации. Проверьте правильность параметров \'group\' и \'token\'.
• 1005 - Версия API устарела.
• 1006 - API сервис временно не доступен.
• 2000 - Превышен лимит обращений к API.
• 3000 - В данный момент нет активной кампании.
• 3001 - Кампания с таким ID не найдена.
• 3002 - Заявка на вывод с таким ID не найдена.
• 3003 - Донат с таким ID не найден.
• 3004 - Запрашиваемая сумма выплаты превышает остаток средств на балансе.
• 3005 - Запрашиваемая сумма выплаты ниже минимальной суммы выплаты для данной платежной системы.
• 3006 - Ошибка списания средств. Повторите запрос.
• 3007 - Создание выплат через API отключено в настройках приложения.
• 3008 - Время окончания указано неправильно. Кампания не может оканчиваться менее чем через три часа от текущего момента.
• 3009 - Запрашиваемая сумма выплаты выше максимальной суммы выплаты для данной платежной системы.
• 3010 - Вывод на данную платежную систему временно недоступен.

Список методов API

1. donates/get - Получение списка донатов
2. donates/get-last - Получение списка последних донатов
3. donates/change-status - Изменить статус доната
4. donates/answer - Добавить/изменить ответ сообщества на донат
5. donates/change-reward-status - Изменить выдачи вознаграждения
6. campaigns/get - Получить список краудфандинговых кампаний (последние 20 кампаний)
7. campaigns/get-active - Получить активную краудфандинговую кампанию
8. campaigns/get-rewards - Получить список вознаграждений краудфандинговой кампании
9. campaigns/change - Обновить информацию о краудфандинговой кампании
10. campaigns/change-reward - Обновить информацию о вознаграждении краудфандинговой кампании
11. payments/get - Получить список заявок на выплату (последние 20 заявок)
12. payments/create - Создать заявку на выплату
13. balance - Получить баланс группы в приложении

donates/get Получение списка донатов

У данного метода есть лимиты. Лимит составляет 100 запросов в сутки. Для регулярной проверки новых донатов используйте метод donates/get-last.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('donates/get', [
	'sort' => 'amount',
	'offset' => 30,
	'len' => 10
]);
print_r($result);

donates/get-last Получение списка последних донатов

У данного метода есть лимиты. Допускается 1 запрос в минуту. Без передачи параметра last допускается максимум 100 запросов в сутки.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('donates/get-last', [
	'last' => 215665
]);
print_r($result);

donates/change-status Изменить статус доната

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('donates/change-status', [
	'id' => 1,
	'status' => 'hidden'
]);
print_r($result);

donates/answer Добавить/изменить ответ сообщества на донат

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('donates/answer', [
	'id' => 1,
	'answer' => 'Спасибо за помощь проекту! 😊'
]);
print_r($result);

donates/change-reward-status Изменить выдачи вознаграждения.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('donates/change-reward-status', [
	'id' => 1,
	'status' => 'sended'
]);
print_r($result);

campaigns/get Получить список краудфандинговых кампаний (последние 20 кампаний).

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('campaigns/get');
print_r($result);

$api = new Keksik(1, 'auth_token');
$result = $api -> request('campaigns/get', [
	'ids' => [1, 3]
]);
print_r($result);

campaigns/get-active Получить активную краудфандинговую кампанию.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('campaigns/get-active');
print_r($result);

campaigns/get-rewards Получить список вознаграждений краудфандинговой кампании.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('campaigns/get-rewards', [
	'campaign' => 1
]);
print_r($result);

campaigns/change Обновить информацию о краудфандинговой кампании.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('campaigns/change', [
	'id' => 1,
	'title' => 'Новое название кампании'
]);
print_r($result);

campaigns/change-reward Обновить информацию о вознаграждении краудфандинговой кампании.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('campaigns/change-reward', [
	'id' => 1,
	'title' => 'Новое название вознаграждения'
]);
print_r($result);

payments/get Получить список заявок на выплату (последние 20 заявок).

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('payments/get');
print_r($result);

$api = new Keksik(1, 'auth_token');
$result = $api -> request('payments/get', [
	'ids' => [1, 3]
]);
print_r($result);

payments/create Создать заявку на выплату.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('payments/create', [
	'system' => 'mobile',
	'purse' => '78005553535',
	'amount' => 50
]);
print_r($result);

balance Получить баланс группы в приложении.

Параметры запроса:

Ответ сервера:

Пример кода на PHP с использованием класса для работы с API.

$api = new Keksik(1, 'auth_token');
$result = $api -> request('balance');
print_r($result);

Callback API

Callback API позволяет задать адрес страницы, на которую, при поступлении нового доната, мы будем отправлять уведомление.

Обратите внимание! На любое уведомление, Callback сервер должен ответить в JSON формате:

{"status": "ok"}

{"status": "ok", "code": "a1b2c3"}

Ниже приведен пример кода страницы для приема уведомлений о новых донатах. Версия PHP не ниже 7.0.

class Callback {
	private $secret_key;

	function __construct($secret_key) {
		$this -> secret_key = $secret_key;
	}

	public function get() {
		$response = json_decode(file_get_contents('php://input'), true);
		if (!$this -> check_hash($response)) return false;
		unset($response['hash']);
		return $response;
	}
	private function check_hash($params) {
		$hash = $params['hash'];
		unset($params['hash']);
		$params = $this -> get_hash_array($params);
		ksort($params);
		array_push($params, $this -> secret_key);
		$hash_str = join(',', $params);
		$sha256 = hash('sha256', $hash_str);
		return ($sha256 == $hash) ? true : false;
	}
	private function get_hash_array($params, $indx = '') {
		$arr = [];
		if ($indx) $indx .= '/';
		foreach ($params as $key => $val) {
			if (is_array($val)) {
				$newarr = $this -> get_hash_array($val, $indx . $key);
				$arr = array_merge($newarr, $arr);
			}
			else {
				$arr[$indx . $key] = $val;
			}
		}
		return $arr;
	}
}

$secret_key = 'секретный_ключ_из_настроек_приложения';
$code = 'код_подтверждения_из_настроек_приложения';

$callback = new Callback($secret_key);
$response = $callback -> get();
if ($response === false) exit('Неверный хеш запроса.');

switch ($response['type']) {
	case 'confirmation':
		echo '{"status": "ok", "code": "' . $code . '"}';
		break;
	case 'new_donate':
		// Записываем данные в response.txt
		$json = json_encode($response, JSON_UNESCAPED_UNICODE);
		file_put_contents('donates.txt', $json . "\n", FILE_APPEND);
		echo '{"status": "ok"}';
		break;
	case 'payment_status':
		// Записываем данные в response.txt
		$json = json_encode($response, JSON_UNESCAPED_UNICODE);
		file_put_contents('payments.txt', $json . "\n", FILE_APPEND);
		echo '{"status": "ok"}';
		break;
}

Проверка хеша запроса.

Для того, чтобы удостовериться в подлиности данных, следует проверять хеш запроса.

Для проверки хеша:

1. Удалите из массива входящих данных элемент с ключом hash.
2. Удалите все подмассивы добавив их элементы в основной массив. При добавлении элементов, добавьте к началу их ключей ключ родителя и слеш. То есть из изначального массива ...

   [
   	"a" => "Элемент 1",
   	"b" => [
   		"c" => "Элемент 2",
   		"d" => [
   			"e" => "Элемент 3",
   			"f" => "Элемент 4"
   		]
   	],
   	"g" => "Элемент 5"
   ]
   	

   ... должен получиться массив ...

   [
   	"a" => "Элемент 1",
   	"b/c" => "Элемент 2",
   	"b/d/e" => "Элемент 3",
   	"b/d/f" => "Элемент 4",
   	"g" => "Элемент 5"
   ]
   	

3. Отсортируйте массив по ключу.
4. Объедините все элементы массива через запятую сохранив порядок сортировки.
5. В конец строки добавьте еще одну запятую и секретный ключ из настроек приложения (не путать с токеном api!). Внимание! Boolean должен подставляться как 1 (для true) и пустая строка (для false).
6. Полученную строку преобразуйте в sha256 хеш. Полученный хеш должен совпадать с присланным нашим сервером.

Данные, которые наш сервер передаст на вашу страницу.

Данные передаются в виде JSON методом POST.

Общие данные (присутствуют в запросах всех типов уведомлений):

Данные для уведомления типа new_donate:

Данные для уведомления типа payment_status: