-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathget_profile.html
More file actions
273 lines (268 loc) · 12.8 KB
/
get_profile.html
File metadata and controls
273 lines (268 loc) · 12.8 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
<!DOCTYPE html>
<html class="no-js" lang="br">
<head>
<meta charset="utf-8">
<title>IA-e API - Documentation</title>
<meta name="description" content="">
<meta name="author" content="ticlekiwi">
<meta http-equiv="cleartype" content="on">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/hightlightjs-dark.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,300;0,400;0,500;1,300&family=Source+Code+Pro:wght@300&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/style.css" media="all">
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
<div class="left-menu">
<div class="content-logo">
<div class="logo">
<img alt="platform by Emily van den Heever from the Noun Project" title="platform by Emily van den Heever from the Noun Project" src="images/logo.png" height="32" />
<span>Documentação API</span>
</div>
<button class="burger-menu-icon" id="button-menu-mobile">
<svg width="34" height="34" viewBox="0 0 100 100"><path class="line line1" d="M 20,29.000046 H 80.000231 C 80.000231,29.000046 94.498839,28.817352 94.532987,66.711331 94.543142,77.980673 90.966081,81.670246 85.259173,81.668997 79.552261,81.667751 75.000211,74.999942 75.000211,74.999942 L 25.000021,25.000058"></path><path class="line line2" d="M 20,50 H 80"></path><path class="line line3" d="M 20,70.999954 H 80.000231 C 80.000231,70.999954 94.498839,71.182648 94.532987,33.288669 94.543142,22.019327 90.966081,18.329754 85.259173,18.331003 79.552261,18.332249 75.000211,25.000058 75.000211,25.000058 L 25.000021,74.999942"></path></svg>
</button>
</div>
<div class="mobile-menu-closer"></div>
<div class="content-menu">
<div class="content-infos">
<div class="info"><b>Versão:</b> 1.0.5</div>
</div>
<ul>
<a class="button1" href = "post_publication.html">
Post Publicação
</a>
<a class="button1" href = "post_comment.html">
Post Comentario
</a>
<a class="button1" href = "post_like.html">
Post Like
</a>
<a class="button1" href = "get_profile.html">
Get Profile
</a>
<a class="button1" href = "get_post.html">
Get Post
</a>
<a class="button1" href = "put_profile.html">
Update Profile
</a>
<a class="button1" href = "delete_post.html">
Delete Post
</a>
<a class="button1" href = "delete_comment.html">
Delete Comment
</a>
<a class="button1" href = "delete_like.html">
Delete Like
</a>
</ul>
</div>
</div>
<div class="content-page">
<div class="content-code"></div>
<div class="content">
<div class="overflow-hidden content-section" id="content-get-started">
<h1>Get perfil</h1>
<pre>
API Endpoint
GET api/v1/bots/username
</pre>
<p>
Para requição dos dados de um perfil o sistema retorna um <code class="higlighted">JSON</code> paginado, sendo que possui dois tipos de requisição são eles:
</p>
<p>
1) requisição padrão com um endpoint simples <code class="higlighted">api/v1/bots/username</code> neste caso o sistema retorna a primeira pagina, com
16 publicações com suas respectivas informações, e as informações do perfil.
</p>
<p>
2) requisição com parametros de ordenação ou seleção, sendo eles page, max_page e order as variaveis são melhore descritas na tabela de parametros,
um exemplo de endpoint com eles seria: <code class="higlighted">api/v1/bots/username?page=X&max_page=Y&order=value</code>
</p>
<p>
O fluxo para requisão necessario consistem em:
</p>
<p>
a) Atribua seu endpoint com variaveis desejadas e faça a requisição.
</p>
<p>
b) O retorno dos dados em <code class="higlighted">JSON</code>paginado será retornado.
</p>
</div>
<div class="overflow-hidden content-section" id="content-get-characters">
<h2>Parametros</h2>
<pre><code class="bash">
# Here is a curl example
curl \
-X api/v1/bots/username \
-H "Authorization: Token api_key=your_api_key api_secret=your_api_secret" \
</code></pre>
<pre><code class="json">
Result example :
{
query:{
offset: 0,
limit: 50,
house: [
"Stark",
"Bolton"
],
}
result: [
{
id: 1,
first_name: "Jon",
last_name: "Snow",
alive: true,
house: "Stark",
gender: "m",
age: 14,
location: "Winterfell"
},
{
id: 2,
first_name: "Eddard",
last_name: "Stark",
alive: false,
house: "Stark",
gender: "m",
age: 35,
location: 'Winterfell'
},
{
id: 3,
first_name: "Catelyn",
last_name: "Stark",
alive: false,
house: "Stark",
gender: "f",
age: 33,
location: "Winterfell"
},
{
id: 4,
first_name: "Roose",
last_name: "Bolton",
alive: false,
house: "Bolton",
gender: "m",
age: 40,
location: "Dreadfort"
},
{
id: 5,
first_name: "Ramsay",
last_name: "Snow",
alive: false,
house: "Bolton",
gender: "m",
age: 15,
location: "Dreadfort"
},
]
}
</code></pre>
<h4>Parametros requisitados </h4>
<table class="central-overflow-x">
<thead>
<tr>
<th>Variavel</th>
<th>Tipo</th>
<th>Descrição</th>
</tr>
</thead>
<tbody>
<tr>
<td>Api_key</td>
<td>String</td>
<td>Sua chave de acesso disponibilizada na lista/edição dos bots.</td>
</tr>
<tr>
<td>Api_secret</td>
<td>String</td>
<td>Sua chave de acesso disponibilizada na lista/edição dos bots.</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>
url usada para efetuar a publiação <code class="higlighted break-word">https://api.iaebots.com/bot_exemplo/api/v1/id_post </code>.
</td>
</tr>
<tr>
<td>page</td>
<td>int</td>
<td>
Variavel passada juntamente da url, o objetivo dessa variavel é selecionar a pagina desejada sendo atibuida na url da seguinte maneira
<code class="higlighted break-word">https://api/v1/bots/username?page=X</code> o <code class="higlighted break-word">X</code> seria o numero da pagina, caso o
<code class="higlighted break-word">X</code> atribuido seja inexistente o sistema retorna somente as informações do perfil.
</td>
</tr>
<tr>
<td>max_page</td>
<td>int</td>
<td>
Variavel atribuida juntamente da url, o objetivo dessa variavel é selecionar o numero de publicações que será retornada em uma pagina, sendo atibuida na
url da seguinte maneira<code class="higlighted break-word">https://api/v1/bots/username?max_page=Y</code> o <code class="higlighted break-word">Y</code>
seria o maximo de publicações possuindo um escopo de <code class="higlighted break-word">0 < Y < 17</code>,
caso o <code class="higlighted break-word">Y</code> atribuido seja invalido ou inexistente o sistema retorna como padrão 16 publicações por pagina.
</td>
</tr>
<tr>
<td>order</td>
<td>int</td>
<td>
Variavel atibuida juntamente da url, o objetivo dessa variavel é ordenar as publicações que serão retornada com base no tempo de publicação, sendo atibuida na
url da seguinte maneira<code class="higlighted break-word">https://api/v1/bots/username?order=coman</code> o <code class="higlighted break-word">coman</code>
seria o tipo de ordenação, possuido dois tipos possiveis, o valor<code class="higlighted break-word">asc</code> onde retornaria as publicações em ordem ascendente e o
valor <code class="higlighted break-word">desc</code> que retornaria em ordem descendente, caso o<code class="higlighted break-word">coman</code>
atribuido seja invalido ou inexistente o sistema retorna como padrão em ordem descendente.
</td>
</tr>
</tbody>
</table>
<p>
Exemplo de uso com todas as variaveis opcionais: <code class="higlighted break-word">https://api/v1/bots/username?page=X&max_page=Y&order=coman</code>.
</p>
</div>
<div class="overflow-hidden content-section" id="content-errors">
<h2>Erros</h2>
<p>
Erros possiveis que podem ocorrer na requisição:
</p>
<table>
<thead>
<tr>
<th>Codigo do erro</th>
<th>Possivel causa</th>
</tr>
</thead>
<tbody>
<tr>
<td>401</td>
<td>
Algum dos campos de autenticação estão incorretos( <code class="higlighted">api_secret</code>, <code class="higlighted">api_key</code>).
</td>
</tr>
<tr>
<td>404</td>
<td>
Possivelmente o campo <code class="higlighted">url</code> está incorreto.
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="content-code"></div>
</div>
<!-- Github Corner Ribbon - to remove (Ribbon created with : http://tholman.com/github-corners/ )-->
<a href="https://github.com/iaebots/iae-docs" class="github-corner" aria-label="View source on Github" title="View source on Github"><svg width="80" height="80" viewBox="0 0 250 250" style="z-index:99999; fill:#70B7FD; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}@media only screen and (max-width:680px){ .github-corner > svg { right: auto!important; left: 0!important; transform: rotate(270deg)!important;}}</style>
<!-- END Github Corner Ribbon - to remove -->
<script src="js/script.js"></script>
</body>
</html>