Listagem de Palavras-Chave
Requisição para a consulta de diversas palavras-chave.
Método GET
https://{api_address}/words
Código de Exemplo
<?php
$params["access_token"] = "### Chave de Acesso ###";
$params["sort"] = "id_desc";
$url = "https://{api_address}/words/?".http_build_query($params);
ob_start();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_exec($ch);
// JSON de retorno
$resposta = json_decode(ob_get_contents());
$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
ob_end_clean();
curl_close($ch);
if($code == "200"){
//Tratamento dos dados de resposta da consulta.
}else{
//Tratamento das mensagens de erro
}
?>
string URLAuth = "https://{api_address}/words/";
NameValueCollection queryParameters = new NameValueCollection();
queryParameters.Add("access_token", "### Chave de Acesso ###");
queryParameters.Add("sort", "id_desc");
List items = new List();
foreach (String name in queryParameters)
items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));
string argsString = String.Join("&", items.ToArray());
WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
request.Credentials = CredentialCache.DefaultCredentials;
WebResponse response = request.GetResponse();
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
Stream dataStream = response.GetResponseStream();
StreamReader reader = new StreamReader(dataStream);
string responseData = reader.ReadToEnd();
Console.WriteLine(responseData);
reader.Close();
response.Close();
String url = "https://{api_address}/words/";
Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");
mapToConvert.put("sort", "id_desc");
String queryString = "";
for (Entry<String, String> entry : mapToConvert.entrySet()) {
queryString += entry.getKey()+"="+ entry.getValue()+"&";
}
try {
URL obj = new URL(url+"?"+queryString);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
con.setRequestProperty("User-Agent", USER_AGENT);
int responseCode = con.getResponseCode();
BufferedReader in ;
if (responseCode >= 200 && responseCode < 300){
in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
}else{
in = new BufferedReader(
new InputStreamReader(con.getErrorStream()));
}
String inputLine;
StringBuilder response = new StringBuilder();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
String resposta = response.toString();
} catch (Exception ex){
// Tratamento da Exception
}
Parâmetro
Campo | Tipo | Descrição |
---|---|---|
access_token | String |
Chave de acesso |
Success 200
Campo | Tipo | Descrição |
---|---|---|
paging | Object |
Dados de paginação |
total | Number |
Total de registros |
page | Number |
Página corrente |
offset | Number |
Registro inicial da página |
limit | Number |
Limite de registros |
maxLimit | Number |
Máximo de registros |
sort | Object[] |
Ordenação |
availableFilters | String[] |
Filtros disponíveis |
appliedFilters | String[] |
Filtros utilizados |
Words | Object[] |
Lista de palavras-chave |
Word | Object |
Dados do palavra-chave |
id | Number |
Código da palavra-chave |
keyword | String |
Palavra-chave |
qty | Number |
Quantidade da palavra-chave |
HTTP/1.1 200 OK
{
"paging": {
"total": 1,
"page": 1,
"offset": 0,
"limit": 1,
"maxLimit": 50
},
"sort": [
{
"id": "desc"
}
],
"availableFilters": [
"id",
"keyword"
],
"appliedFilters": [],
"Words": [
{
"Word":{
"id": "123",
"keyword": "palavra-chave",
"qty": "3"
}
}
]
}
Consultar Palavra-Chave
Requisição para a consulta de dados de uma palavra-chave.
Método GET
https://{api_address}/words/:id
Código de Exemplo
<?php
$params["access_token"] = "### Chave de Acesso ###";
$url = "https://{api_address}/words/123?".http_build_query($params);
ob_start();
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_exec($ch);
// JSON de retorno
$resposta = json_decode(ob_get_contents());
$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
ob_end_clean();
curl_close($ch);
if($code == "200"){
//Tratamento dos dados de resposta da consulta.
}else{
//Tratamento das mensagens de erro
}
?>
string URLAuth = "https://{api_address}/words/123";
NameValueCollection queryParameters = new NameValueCollection();
queryParameters.Add("access_token", "### Chave de Acesso ###");
List items = new List();
foreach (String name in queryParameters)
items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));
string argsString = String.Join("&", items.ToArray());
WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
request.Credentials = CredentialCache.DefaultCredentials;
WebResponse response = request.GetResponse();
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
Stream dataStream = response.GetResponseStream();
StreamReader reader = new StreamReader(dataStream);
string responseData = reader.ReadToEnd();
Console.WriteLine(responseData);
reader.Close();
response.Close();
String url = "https://{api_address}/words/123";
Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");
String queryString = "";
for (Entry<String, String> entry : mapToConvert.entrySet()) {
queryString += entry.getKey()+"="+ entry.getValue()+"&";
}
try {
URL obj = new URL(url+"?"+queryString);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
con.setRequestProperty("User-Agent", USER_AGENT);
int responseCode = con.getResponseCode();
BufferedReader in ;
if (responseCode >= 200 && responseCode < 300){
in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
}else{
in = new BufferedReader(
new InputStreamReader(con.getErrorStream()));
}
String inputLine;
StringBuilder response = new StringBuilder();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
String resposta = response.toString();
} catch (Exception ex){
// Tratamento da Exception
}
Parâmetro
Campo | Tipo | Descrição |
---|---|---|
access_token | String |
Chave de acesso |
:id | Number |
Código da palavra-chave |
Success 200
Campo | Tipo | Descrição |
---|---|---|
Word | Object |
Dados do palavra-chave |
id | Number |
Código da palavra-chave |
keyword | String |
Palavra-chave |
qty | Number |
Quantidade da palavra-chave |
HTTP/1.1 200 OK
{
"Word":{
"id": "123",
"keyword": "palavra-chave",
"qty": "3"
}
}
Comentários