Espresso API v2

Acesse os dados da sua empresa na plataforma Espresso e crie integrações com ERP ou dashboard personalizados. A API Espresso permite que outros sistemas consumam os dados por meio de métodos REST. Esta documentação descreve os métodos disponíveis para leitura, com exemplos de recursos para filtros, ordenção, e consultas mais flexíveis.

Para ter acesso aos dados da sua empresa por meio da API, é necessário a utilização de um token de acesso. O token é único para cada empresa e pode ser solicitado enviando um email para suporte@espressoapp.com.br. Mantenha o token em local seguro, pois ele dará acesso a dados de sua empresa na plataforma. Se for necessário, por questões de segurança, solicite um novo token.

A API utiliza o padrão Json API, como documentado em https://jsonapi.org/. Uma das grandes vantagens de utilizar esse padrão está em poder utilizar uma das inumeras implemetações (client side) de diferentes linguagens, listadas em https://jsonapi.org/implementations/#client-libraries.

Clique no botão "Run in Postman", no canto superior direito, e começe a utilizar a API agora mesmo. Em caso de dúvidas ou sugestões, nos envie um email através do suporte@espressoapp.com.br.

Recursos

Incluir relacionamento

Em cada é possível incluir os objetos relacionados ao objeto principal. Segue um exemplo abaixo de como incluir as despesas relacionadas ao relatório na listagem de relatórios. Mais informações em https://jsonapi.org/format/#fetching-includes.

# inclui as despesas relacionadas ao relatório
https://app.espressoapp.com.br/api/v2/company/reports?include=expenses

Filtros

É possível filtrar por alguns atributos listados na resposta de cada objeto. A abaixo a documentação irá especificar quais campos poderão ser filtrados em cada um dos métodos. Segue um exemplo abaixo de um filtro aplicado ao relatório.

# filtra os relatórios pelo status
https://app.espressoapp.com.br/api/v2/company/reports?filter[status]=0

# filtra os relatórios pela data de aprovação
https://app.espressoapp.com.br/api/v2/company/reports?filter[approved_at][ge]=2018-12-01&filter[approved_at][le]=2018-12-30

Paginação

Por padrão, todas as listas de objetos tem paginação. Cada página terá por padrão 20 objetos, podendo ter no máximo 30. Segue abaixo um exemplo de como utilizar a paginação.

# filtra a lista de relatório na segunda página de tamanho 15
https://app.espressoapp.com.br/api/v2/company/reports?page[number]=2&page[size]=15

Ordenação

Por padrão, todas as listas são ordenadas de forma decrescente pelo campo created_at. Segue um exemplo abaixo de ordenação dos relatórios.

# ordena de forma crescente pelo número a lista de relatórios
https://app.espressoapp.com.br/api/v2/company/reports?sort=number

# ordena de forma decrescente pelo número a lista de relatórios
https://app.espressoapp.com.br/api/v2/company/reports?sort=-number