Snippets

Maiquel Ludwig Searchbar API Reference

You are viewing an old version of this snippet. View the current version.
Revised by Maiquel Ludwig f758cb7
snippet.markdown
Raw

Searchbar.org API Reference

Este documento detalha as principais rotas da API para usuário desenvolvedor e integração com o Searchbar.

Antes de começar

A Url base da API do Searchbar é

https://api.searchbar.org/v1

Autenticação

Para ter acesso à API Searchbar é 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"

POST /account/login

{
    "email": "seuemail@exemplo.com",
    "password": "suasenha"
}
Parâmetro Tipo Descrição
email String O email da sua conta Searchbar
password String A senha da sua conta Searchbar

Exemplo Retorno

{
    "user": "meuemail@exemplo.com",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCJ6IkpXVCJ9.eyJpZCI6IjViZWM2MzIxN2IartcwMjJlMDU3OGNlMyIsInRva2VuVHlwZSI6InByaXZhdGUiLCJyb2xlIjoiQURNSU4iLCJpYXQiOjE1OTE2NzYwNjksImV4cCI6MTU5MTc2MjQ2OX0.Gotjepi8xfa8oakzVg2eMkEm3GMpCuNvmkdcJejJEyc",
    "publicToken": "eyJhbGciOiJIUzI1NiPirnR5cCI6IkpXVCJ9.eyJpZCI6IjViZWM2MzIxN2IwYTcwMfg45sU3OGNlMyIsInRva2VuVHlwZSI6InB1YmxpYyIsImlhdCI6MTU5MTY3NjA2OSwiZXhwIjoxNTkxNzYyNDY5fQ.Ve68IS19aMrddWf800V1eDCKa_vy8Kqvek5UDT0o7b0",
    "expirationDate": "2020-04-21T04:14:29.000Z"
}
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

HTTP Request

{{Request.ExampleRequestUrl}}

Request parameters

In the request URL, provide the following query parameters with values.

Parameter Type Description

Optional request headers

Name Value

Request body

Do not supply a request body with this method.

Example

Request
Response

Remarks

HTTPS SSH

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