Linha Do Tempo

Conceitos Básicos

O primeiro passo para o compreendimento da nossa API é entender a url fundamental do nosso sistema, com base nela você buscar em nossa base de dados tudo o que deseja para embarcar em suas aplicações. As nossas urls são as seguintes:

http://localhost:3000/search/.(:format)
http://localhost:3000/search/(:date).(:format)

Os formatos que disponibilizamos são "XML", "JSON" e "CSV" para você embarcar em suas aplicações da forma que julgar melhor. Para usar basta substituir (:format) pelos padrões citados. As datas deverão estar no padrão "dd-mm-aaaa" e deverão ser substituídas em (:date).
Para padronizar os nossos examplos iremos usar o padrão JSON. Pedimos aos desenvolvedores que também usem o padrão JSON em suas aplicações fazendo com que os arquivos das requisições sejam menos e mais dinâmicos do que XML ou CSV.

Pesquisa por Data

Para buscar em nossa base de dados você deverá inicialmente inserir uma data nas requisições que fizer, para isso você deverá insirar uma date na url ensinada nos conceitos básicos. À partir deste ponto você receberá um array de json no seguinte formato:

[
  {
    "id": 1,
    "title": "Title Example",
    "date": "2012-10-09",
    "category": 0,
    "language": 0,
    "description": "Description Example",
    "created_at": "1991-02-21T10:00:00.303Z",
    "updated_at": "1991-02-21T10:00:00.303Z",
    "avatar_url_large": "/events/large/example.png",
    "avatar_url_thumb": "/events/thumb/example.png",
    "user_info": {
      "email": "example@domain.com",
      "name": "Name Example",
      "birthdate": "1991-02-22",
      "gender": "Male",
      "avatar_thumb": "/users/thumb/example.jpg?",
      "language": "Português(Brasil)",
      "description": "Description Example"
    }
  },
  ...
]

Anteriores e Posteriores

A pesquisa por data retornará todos os eventos anteriores a data informada. Para que seja possível requisitar os eventos posteriores a data informada, você deverá incluir um parâmetro "after=true" em sua url de requisição. Tomemos como exemplo:

http://localhost:3000/search/(:date).(:format)?after=true

O padrão para uma requisição dos eventos anteriores e posterioes possuem o seguinte padrão:
Eventos Anteriores - o primeiro é o mais próximo da data e os seguintes são os mais distantes anteriores a data.
Eventos Posteriores - o primeiro é o mais próximo da data e os seguintes são os mais distantes posteriores a data.

Paginação e Quantidades

Você já deve ter reparado que as requisições vêm em blocos de dez(10) por padrão, mas isso pode ser alterado através do parâmetro "per" e a sua paginação pelo parâmetro "page". Segue alguns urls de exemplo:

http://localhost:3000/search/(:date).(:format)?per=10
http://localhost:3000/search/(:date).(:format)?page=10
http://localhost:3000/search/(:date).(:format)?per=10&page=10
http://localhost:3000/search/(:date).(:format)?page=10&per=10

Linguagem Específica

Você poderá também fazer um pesquisa sobre em uma língua específica uma vez que o nosso sistema oferece um internacionalização elegante para atingir um público específico. Para isso as querys deverão possuir o parâmetro "locale" na url. Como exemplo:

http://localhost:3000/search/(:date).(:format)?locale=pt-BR

No momento temos dísponível o cadastramento de usuários e linguagens em duas linguagens sendo elas:

Português(Brasil)
English

Usuários Cadastrados

Através das querys você pode obter apenas os eventos públicos, porém você pode obter os eventos privados informando o email do usuário que deseja capturar estes eventos, o mesmo pode ser feito através dos parâmetro "user" na url. Como exemplo:

http://localhost:3000/search/(:date).(:format)?user=example@domain.com

URL de Exemplos

Para tornar esta documentação ainda mais simples, basta você inserir os parâmetros que as url serão gerada para você nas espeficiações acima.

Data	Paginação	Quantidade

Linguagem	Usuário	Formato

	Ordem
	Antes Depois

{{url}}

A data inserida está em um formato inválida
O email inserido está em um formato inválido

Nossa api

O que é uma API?

O que oferecemos?

Como usar a nossa base?