Snippets

Maiquel Ludwig Searchbar API Reference

Updated by Maiquel Ludwig
View revision

File snippet.markdown Modified

  • Ignore whitespace
  • Hide word diff 
 ### POST /page/
 Insere páginas customizadas ou atualiza páginas existentes.
 
-*Importante*: Este recurso possui limite de 50 páginas adicionáveis no mesmo request e o Payload não deve ultrapassar 500 KBs.
+*Importante*: O tamanho do Payload não deve ultrapassar 500 KBs.
  
 ```
 {
Updated by Maiquel Ludwig
View revision

File snippet.markdown Modified

  • Ignore whitespace
  • Hide word diff 
 | active | Boolean | Ativo ou Inativo
 
 ___
-### POST /account/site
+### PUT /account/site
 Define o site principal da sua conta.
 
-*Cuidado:* este request atualiza todas as páginas da sua conta, exceto as inseridas manualmente pelo usuário. 
+*Cuidado:* este endpoint atualiza todas as páginas da sua conta, exceto as inseridas manualmente via POST /page. 
 ```
 {
 	"site":"https://meunovosite.com.br"
 ### GET /page/
 Efetua uma busca por texto nas páginas indexadas na sua conta
 ```
-GET /page/?q=termo&offset=0&size=10
+GET /page/?q=termo&offset=0&size=10&tag=news
 ```
 
 | Parâmetro | Tipo | Descrição |
 | q | String | Query a ser buscada
 | offset | Number | Define o offset de paginação para retornar a busca
 | size | Number | Define a quantidade de resultados por página retornada (máximo 100)
+| tag | String | Se definida, filtra os resultados pela tag informada. Pode ser adicionada mais de uma tag à URL.
 
 Exemplo de Retorno
 ```
         "total": 61,
         "from": "0",
         "to": 10,
+        "tags": [
+                {
+                    "key": "news",
+                    "doc_count": 25
+                }
+            ],
         "results": [
             {
                 "_index": "pages",
 | total | Number | Quantidade total de páginas encontradas que atendem ao termo buscado
 | from | Number | Início da paginação atual
 | to | Number | Fim da paginação atual
+| tags | Array | Lista de tags relacionadas aos resultados e suas quantidades 
 | results | Array | Lista de Resultados
 
 ___
Updated by Maiquel Ludwig
View revision

File snippet.markdown Modified

  • Ignore whitespace
  • Hide word diff 
             "url": "http://example.com/2",
             "title": "This is a title example 2",
             "description": "This is the description from the page. It can be a large text.",
+            "tags": ["blog", "news"],
             "image": "https://upload.wikimedia.org/wikipedia/commons/b/b6/Image_created_with_a_mobile_phone.png"
         },
         {
 | url | String | URL da página a ser adicionada (Obrigatório)
 | title | String | Título da página a ser adicionada (Obrigatório)
 | description | String | Descrição da página a ser adicionada
+| tags | String Array | Tags opcionais para classificar páginas
 | weight | Number | Peso da página. Páginas multiplicam seu score com o seu peso para se tornarem artificialmente mais relevantes.
  
  ___
Updated by Maiquel Ludwig
View revision

File snippet.markdown Modified

  • Ignore whitespace
  • Hide word diff 
 | 400 | Request mal formado
 | 422 | Payload/json com campos faltantes
 
+Todos os requests possuem *Rate Control* (a fim de evitar ataques DDoS). Portanto, considere o limite de 3 requests simultâneos, aguardando a resposta para iniciar novos requests.
+
 ___
 ### Autenticação
 
 ### POST /page/
 Insere páginas customizadas ou atualiza páginas existentes.
 
-*Importante*: Este recurso possui rate control, limite de 50 páginas adicionáveis no mesmo request e o Paylod não deve ultrapassar 500 KBs.
+*Importante*: Este recurso possui limite de 50 páginas adicionáveis no mesmo request e o Payload não deve ultrapassar 500 KBs.
  
 ```
 {
Updated by Maiquel Ludwig
View revision

File snippet.markdown Modified

  • Ignore whitespace
  • Hide word diff 
 | Código | Descrição |
 |:----------|:-----
 | 401 | Usuário não autorizado ou token inválida |
-| 400 | Request mal formatado
+| 400 | Request mal formado
 | 422 | Payload/json com campos faltantes
 
 ___
 ### Autenticação
 
-Para ter acesso à API Searchbar é necessário obter uma token de autorização que deve ser incluída como Bearer Token no cabeçalho "Authentication" em todos os demais requests.
+Para ter acesso à API Searchbar é necessário obter uma token de autorização, que deve ser incluída como Bearer Token no cabeçalho "Authentication" em todos os demais requests.
 ```
 "Authorization" : "Bearer [sua_token_de_authorização]"
 ```
 | Parâmetro | Tipo | Descrição |
 |:----------|:-----|:------------|
 | user | String | O email da sua conta Searchbar
-| token | String | Sua token privada para utilização da API. *Não publique em páginas públicas*. Expira após 24hrs
-| publicToken | String | Sua token pública para utilização em ambientes públicos. Não Expira.
-| expirationDate | ISO Date | Data da expiração da sua token privada. Após esse período, é necessário novo login
+| token | String | Sua token privada para utilização da API. *Não publique ou compartilhe a sua token privada*. Expira após 24hrs
+| publicToken | String | Sua token pública para utilização em ambientes públicos e no seu site. Não Expira.
+| expirationDate | ISO Date | Data da expiração da sua token privada. Após esse período, é necessário novo login.
 
 ___
 ### GET /account/site
  2. 1
  3. 2
HTTPS SSH

You can clone a snippet to your computer for local editing. Learn more.