AllPositionResource.php
14.4 KB
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
<?php
/**
* Created by PhpStorm.
* User: Alex Savenko
* Date: 22.02.2017
* Time: 20:29
*/
namespace App\Resources;
use App\Constants\AclRoles;
use App\Controllers\AllPositionController;
use PhalconApi\Constants\HttpMethods;
use PhalconRest\Api\ApiEndpoint;
use PhalconRest\Api\ApiResource;
class AllPositionResource extends ApiResource
{
public function initialize() {
$this
->name('All Position')
->expectsJsonData()
->itemKey('ap')
->collectionKey('ap')
->deny(AclRoles::UNAUTHORIZED)
->handler(AllPositionController::class)
/** -------------------- [GET] project ------------------------------ **/
->endpoint(
ApiEndpoint::factory('/project', HttpMethods::GET, 'projectAction')
->name('project')
->description('Данные о проекте')
->paramsDescription([
'required params' => [
'project' => "integer(ID проекта)"
]
])
->exampleResponse([
"url" => "rukzachok.com.ua(URL проекта)",
"cy" => "60(тИЦ)",
"pr" => "0(Google PageRank)",
"yaca" => "0(Наличие сайта в Яндекс каталоге)",
"dmoz" => "0(Наличие сайта в DMOZ)",
"yahoo" => "0(Наличие сайта в Yahoo)",
"name" => "rukzachok.com.ua",
"interval" => 0
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
/** -------------------- [GET] projects ----------------------------- **/
->endpoint(
ApiEndpoint::factory('/projects', HttpMethods::GET, 'projectsAction')
->name('projects')
->description('Список проектов пользователя')
->paramsDescription([
'required params' => [],
'optional params' => [
'id_group' => "integer(ID проекта)"
]
])
->exampleResponse([
[
"id_project" => "{id}(ID проекта)",
"id_group" => "11111(ID группы проектов)",
"url" => "8nebo.com(URL проекта)",
"cy" => "20(тИЦ)",
"pr" => "0(Google PageRank)",
"name" => "8nebo.com",
"interval" => 7,
"sleep" => 1
],
[
"id_project" => "{id}(ID проекта)",
"id_group" => "11111(ID группы проектов)",
"url" => "a-v-z.com.ua(URL проекта)",
"cy" => "10(тИЦ)",
"pr" => "0(Google PageRank)",
"name" => "",
"interval" => 0,
"sleep" => 0
]
])
->allow(AclRoles::USER)
)
/** ------------------------------------------------------------------**/
/** -------------------- [GET] projects_group ----------------------- **/
->endpoint(
ApiEndpoint::factory('/projects_group', HttpMethods::GET, 'projectsGroupAction')
->name('projects group')
->description('Список групп проектов')
->paramsDescription([
'required params' => []
])
->exampleResponse([
[
"id_group" => "{id}(ID группы проектов)",
"group" => "bkko.com.ua(Название группы)"
],
[
"id_group" => "{id}(ID группы проектов)",
"group" => "Dveri(Название группы)"
]
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
/** -------------------- [GET] queries ------------------------------ **/
->endpoint(
ApiEndpoint::factory('/queries', HttpMethods::GET, 'queriesAction')
->name('queries')
->description('Список запросов, по которым определяется позиция сайта')
->paramsDescription([
'required params' => [
'project' => 'integer(ID проекта)'
],
'optional params' => [
'id_group' => 'integer(ID группы запросов)'
]
])
->exampleResponse([
[
"id_query" => "{id}(ID запроса)",
"id_group" => "{id}(ID группы запросов)",
"query" => "=рюкзаки переноски для детей(Запрос)",
"freq" => "50(Частота запроса)",
"url" => "(URL целевой страницы)"
],
[
"id_query" => "{id}(ID запроса)",
"id_group" => "{id}(ID группы запросов)",
"query" => "dakine кошелек(Запрос)",
"freq" => "10(Частота запроса)",
"url" => "(URL целевой страницы)"
]
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
/** -------------------- [GET] queries_group ------------------------ **/
->endpoint(
ApiEndpoint::factory('/queries_group', HttpMethods::GET, 'queriesGroupAction')
->name('queries group')
->description('Список групп запросов')
->paramsDescription([
'required params' => ['project' => 'integer(ID проекта)']
])
->exampleResponse([
[
"id_group" => "{id}(ID группы запросов)",
"group" => "head рюкзак(Название группы)"
],
[
"id_group" => "{id}(ID группы запросов)",
"group" => "quiksilver рюкзак(Название группы)"
]
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
/** -------------------- [GET] report ------------------------------- **/
->endpoint(
ApiEndpoint::factory('/report', HttpMethods::GET, 'reportAction')
->name('report')
->description('Отчет по позициям сайта')
->paramsDescription([
'required params' => [
'project' => 'integer(ID проекта)'
],
'optional params' => [
'date' => 'date(дата отчета в формате Y-m-d (например, 2010-12-31))',
'prev_date' => 'date(дата для сравнения позиции сайта в формате Y-m-d (например, 2010-12-30))'
]
])
->exampleResponse([
"count" => "526(Количество запросов)",
"top3" => "50(Запросов в ТОП 3)",
"top10" => "113(Запросов в ТОП 3)",
"top30" => "275(Запросов в ТОП 3)",
"down" => "230(Позиций улучшилось)",
"up" => "205(Позиций улучшилось)",
"sengines" => [
[
"id_se" => "{id}(ID поисковой системы)",
"name_se" => "Google(название поисковой системы)",
"name_region" => "com.ua/Киев(название региона)"
],
[
"id_se" => "{id}(ID поисковой системы)",
"name_se" => "Google(название поисковой системы)",
"name_region" => "com.ua(название региона)"
]
],
"queries" => [
[
"id_query" => "{id}(ID запроса)",
"query" => "=рюкзаки переноски для детей(запрос)",
"wordstat" => "50(частота запроса)"
],
[
"id_query" => "{id}(ID запроса)",
"query" => "dakine кошелек(запрос)",
"wordstat" => "10(частота запроса)"
]
],
"positions" => [
[
"position " => "{id}(ID запроса)",
"prev_position " => "=рюкзаки переноски для детей(запрос)",
"change_position" => "50(частота запроса)",
"url" => "50(частота запроса)"
],
[
"position " => "(текущая позиция сайта)",
"prev_position " => "(предыдущая позиция сайта)",
"change_position" => "(изменение позиции сайта)",
"url" => "(найденный URL)"
]
]
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
/** -------------------- [GET] visibility --------------------------- **/
->endpoint(
ApiEndpoint::factory('/visibility', HttpMethods::GET, 'visibilityAction')
->name('visibility')
->description('Данные о видимости сайта за указанный период')
->paramsDescription([
'required params' => [
'project' => 'integer(ID проекта)'
],
'optional params' => [
'start' => 'date(начальная дата в формате Y-m-d (например, 2010-12-01))',
'end' => 'date(конечная дата в формате Y-m-d (например, 2010-12-31))',
'id_se' => 'integer(ID поисковой системы)'
]
])
->exampleResponse([
"2017-02-13" => "0.2",
"2017-02-15" => "0.2",
"2017-02-20" => "0.3",
"2017-02-26" => "0.3",
"2017-03-06" => "0.3",
"2017-03-12" => "0.2"
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
/** -------------------- [GET] visibility --------------------------- **/
->endpoint(
ApiEndpoint::factory('/report_dates', HttpMethods::GET, 'reportDatesAction')
->name('report dates')
->description('Список дат, когда обновлялись позиции сайта')
->paramsDescription([
'required params' => [
'project' => 'integer(ID проекта)'
],
])
->exampleResponse([
"2017-02-13" => "0.2",
"2017-02-15" => "0.2",
"2017-02-20" => "0.3",
"2017-02-26" => "0.3",
"2017-03-06" => "0.3",
"2017-03-12" => "0.2"
])
->allow(AclRoles::USER)
)
/** ----------------------------------------------------------------- **/
;
}
}