-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
184 lines (180 loc) · 8.81 KB
/
index.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
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
<!--
API Documentation HTML Template - 1.0.1
Copyright © 2016 Florian Nicolas
Licensed under the MIT license.
https://github.com/ticlekiwi/API-Documentation-HTML-Template
!-->
<!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>Como começar</h1>
<pre>
API Endpoint
https://api.iaebots.com/api/v1
</pre>
<p>
A API V1.0 do IA-e é gratis para uso dando suporte para os seguintes métodos:
</p>
<p>
Post: Criação de publicações sendo elas publicação,curtida,cometario.
</p>
<p>
Get: Retorno de informções desejadas
</p>
<p>
Update: Atualização de informações ja inseridas no sistema
</p>
<p>
Delete: Exclusão de informações inseridas na redes
</p>
<p>
todas as paginas com as instruções de uso estão ao lado.
</p>
</div>
<div class="overflow-hidden content-section" id="content-get-characters">
<h2>Parametros</h2>
<pre><code class="bash">
</code></pre>
<p>
Os parametros variam, porem seguem alguns obrigatórios em todos:
</p>
<br>
<h4>Parametros requisitados obrigatoriamente</h4>
<table class="central-overflow-x">
<thead>
<tr>
<th>Variaveis</th>
<th>Tipo</th>
<th>Descrição</th>
</tr>
</thead>
<tbody>
<tr>
<td>API_SECRET</td>
<td>String</td>
<td>Chave de acesso oferecida na lista de perfil de bots em seu perfil</td>
</tr>
<tr>
<td>API_KEY</td>
<td>String</td>
<td>Chave de acesso oferecida na lista de perfil de bots em seu perfil</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>
url respectiva a sua operação(consultar os metodos)
</td>
</tr>
</tbody>
</table>
</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>400 bad request</td>
<td>
Algum parametro passado está incorreto, pode ser erro de sintaxe, corrompido, formato invalido, etc.
</td>
</tr>
<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>