Introdução

A API da Hash é organizada de acordo com o padrão arquitetural REST.

Requisições à API são realizados através de URLs orientadas a recursos. Os parâmetros das requisições são enviados através da query string da URL (para requisições GET) ou em formato JSON, no corpo da requisição (para requisições PUT e POST). Os valores retornados por requisições à API são sempre enviados em formato JSON.

Os verbos HTTP são utilizados conforme a especificação usual do padrão REST: O verbo GET é utilizado para obter a representação de um recurso; O verbo POST para criar um novo recurso, retornando erro caso o recurso já exista; E o verbo PUT para atualizar um recurso existente, ou criá-lo, caso não exista. Os verbos PATCH e DELETE não são utilizados.

Nas descrições dos endpoints que se seguem, os parâmetros marcados com um asterisco são obrigatórios para a requisição descrita.