forked from binarymaster/3WiFi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apidoc.html
30 lines (22 loc) · 1.38 KB
/
apidoc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<title>3WiFi: Описание API</title>
<head>
</head>
<body>
<table><tr><td align=center>
<h2>Описание API</h2>
Сервис предоставляет доступ к базе данных через API.<br>
Ниже описан процесс посылки запроса, а так же возможные типы запросов.<br><br>
<span style="text-align: left; float: left">
<b>Процесс посылки запроса:</b><br>
Обработчик находится по адресу: "/api/ajax.php". В для авторизации используются API-ключи. В настоящий момент реализован только функционал для R-ключей.<br>
Методом GET передаются параметры "Query" (название вызываемого API) и "Key" (R или W ключ, в зависимости от вызываемого API).<br>
<b>Возможные значение параметра Query:</b><br><br>
<b>GetApiKeys</b><br>
Пример: Query=GetApiKeys<br>
Метод: POST
Параметр Login - логин пользователя<br>
Параметр Password - пароль пользователя<br>
Возвращается ответ в виде JSON-объекта вида: {"Successes":true, "lastupdate": *unixtime*, "r": *r-key*, "w": *w-key*}
</span>
</td></tr></table>
</body>