Blame view

app/library/App/Resources/AllPositionResource.php 12.2 KB
b660745b   Alex Savenko   git bug
1
2
3
4
5
6
7
8
9
10
11
  <?php
  /**
   * Created by PhpStorm.
   * User: Alex Savenko
   * Date: 22.02.2017
   * Time: 20:29
   */
  
  namespace App\Resources;
  
  
056ab121   Alex Savenko   ga fix
12
  use App\Constants\AclRoles;
b660745b   Alex Savenko   git bug
13
  use App\Controllers\AllPositionController;
e83a94b3   Alex Savenko   docs + ap
14
15
  use Phalcon\Acl;
  use PhalconApi\Constants\HttpMethods;
056ab121   Alex Savenko   ga fix
16
  use PhalconRest\Api\ApiEndpoint;
b660745b   Alex Savenko   git bug
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  use PhalconRest\Api\ApiResource;
  
  class AllPositionResource extends ApiResource
  {
  
      public function initialize() {
  
          $this
              ->name('All Position')
              ->expectsJsonData()
              //->transformer(ModelTransformer::class)
              ->itemKey('ap')
              ->collectionKey('ap')
              ->deny(AclRoles::UNAUTHORIZED)
              ->handler(AllPositionController::class)
  
e83a94b3   Alex Savenko   docs + ap
33
34
              ->endpoint(
                  ApiEndpoint::factory('/project', HttpMethods::GET, 'projectAction')
34cfbfc0   Alex Savenko   allposition docs
35
36
                      ->name('project')
                      ->description('Данные о проекте')
ec2de8a1   Alex Savenko   docs
37
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
                          '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)
37701e29   Alex Savenko   ap testing
53
54
              )
  
e83a94b3   Alex Savenko   docs + ap
55
56
              ->endpoint(
                  ApiEndpoint::factory('/projects', HttpMethods::GET, 'projectsAction')
34cfbfc0   Alex Savenko   allposition docs
57
58
                      ->name('projects')
                      ->description('Список проектов пользователя')
ec2de8a1   Alex Savenko   docs
59
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
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
                          '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)
37701e29   Alex Savenko   ap testing
88
89
              )
  
e83a94b3   Alex Savenko   docs + ap
90
91
              ->endpoint(
                  ApiEndpoint::factory('/projects_group', HttpMethods::GET, 'projectsGroupAction')
34cfbfc0   Alex Savenko   allposition docs
92
93
                      ->name('projects group')
                      ->description('Список групп проектов')
ec2de8a1   Alex Savenko   docs
94
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
95
96
97
98
99
100
101
102
103
104
105
106
107
                          'required params' => []
                      ])
                      ->exampleResponse([
                          [
                              "id_group"  => "{id}(ID группы проектов)",
                              "group"     => "bkko.com.ua(Название группы)"
                          ],
                          [
                              "id_group"  => "{id}(ID группы проектов)",
                              "group"     => "Dveri(Название группы)"
                          ]
                      ])
                      ->allow(AclRoles::USER)
37701e29   Alex Savenko   ap testing
108
109
              )
  
e83a94b3   Alex Savenko   docs + ap
110
111
              ->endpoint(
                  ApiEndpoint::factory('/queries', HttpMethods::GET, 'queriesAction')
34cfbfc0   Alex Savenko   allposition docs
112
113
                      ->name('queries')
                      ->description('Список запросов, по которым определяется позиция сайта')
ec2de8a1   Alex Savenko   docs
114
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
                          '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)
f0d4c855   Alex Savenko   ap testing
139
140
              )
  
e83a94b3   Alex Savenko   docs + ap
141
142
143
144
              ->endpoint(
                  ApiEndpoint::factory('/queries_group', HttpMethods::GET, 'queriesGroupAction')
                      ->name('queries group')
                      ->description('Список групп запросов')
ec2de8a1   Alex Savenko   docs
145
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
146
147
148
149
150
151
152
153
154
155
156
157
                          'required params' => ['project' => 'integer(ID проекта)']
                      ])
                      ->exampleResponse([
                          [
                              "id_group"  => "{id}(ID группы запросов)",
                              "group"     => "head рюкзак(Название группы)"
                          ],
                          [
                              "id_group"  => "{id}(ID группы запросов)",
                              "group"     => "quiksilver рюкзак(Название группы)"
                          ]
                      ])
e83a94b3   Alex Savenko   docs + ap
158
159
160
161
162
                      ->allow(AclRoles::USER)
              )
  
              ->endpoint(
                  ApiEndpoint::factory('/report', HttpMethods::GET, 'reportAction')
34cfbfc0   Alex Savenko   allposition docs
163
164
                      ->name('report')
                      ->description('Отчет по позициям сайта')
ec2de8a1   Alex Savenko   docs
165
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
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
                          '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)
e83a94b3   Alex Savenko   docs + ap
221
222
223
224
              )
  
              ->endpoint(
                  ApiEndpoint::factory('/visibility', HttpMethods::GET, 'visibilityAction')
34cfbfc0   Alex Savenko   allposition docs
225
226
                      ->name('visibility')
                      ->description('Данные о видимости сайта за указанный период')
ec2de8a1   Alex Savenko   docs
227
                      ->paramsDescription([
34cfbfc0   Alex Savenko   allposition docs
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
                          '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)
b660745b   Alex Savenko   git bug
246
247
248
249
250
251
              )
          ;
  
      }
  
  }