API Hashiro

A API básica atende provedores e clientes na mesma instância de produção:

https://api.hashiro.ai/api/

Os caminhos desta referência são relativos à base. /users/me corresponde a https://api.hashiro.ai/api/users/me.

Autenticação

Envie seu token no cabeçalho X-HASHIRO-TOKEN:

curl --fail-with-body \
  -H "X-HASHIRO-TOKEN: $HASHIRO_TOKEN" \
  https://api.hashiro.ai/api/users/me

Defina HASHIRO_TOKEN no ambiente com o token gerado em Minha conta no console. Consulte Autenticação.

Escopo de provedores e clientes

Conta	Dados autorizados
Provedor	Organização própria e clientes explicitamente vinculados, quando a rota permite
Cliente	Organização própria, incluindo resultados publicados das avaliações do provedor

Função, licença, associação e propriedade do projeto são verificados separadamente. Informar o ID de um cliente não concede acesso irrestrito. Clientes não podem editar a configuração dos projetos do provedor nas rotas básicas de escrita. Projetos gerenciados pelo cliente permitem as operações autorizadas dos próprios responsáveis.

Referência

• Projetos e escopo.
• Ativos, URLs e serviços.
• Achados e revisão.
• Organizações e usuários.

Requisições e respostas

Envie Content-Type: application/json para JSON. Endpoints de arquivos usam o formato específico, que pode ser multipart ou dados de imagem em JSON.

Listas podem ser arrays, detalhes são objetos e escritas retornam mensagens ou identificadores. Não existe um envelope data universal.

Erros normalmente contêm error ou message. Confira o status HTTP antes de tratar a resposta como sucesso.

Status	Significado
400	Parâmetros ou corpo inválidos
401	Autenticação ausente ou inválida
403	Permissão, licença ou acesso à organização insuficientes
404	Recurso inexistente ou invisível à conta
409	Conflito, inclusive versão de revisão desatualizada
429	Limite de requisições atingido
5xx	Falha no servidor ou serviço externo

Paginação

Listas básicas usam page e pageSize, não limit. A primeira página é 1. Métricas de projetos usam 10 itens por padrão; ativos e achados usam 100. O servidor pode limitar páginas grandes. Nem toda lista tem contagem total ou metadados compartilhados.

curl --fail-with-body -H "X-HASHIRO-TOKEN: $HASHIRO_TOKEN" \
  'https://api.hashiro.ai/api/scans/?project=my-project&page=1&pageSize=100'

Consulte páginas seguintes até não haver mais registros. Caminhos por projeto usam o identificador, não o nome de exibição.

Limites e novas tentativas

Login, OTP, recuperação de senha e ações assistidas por IA têm limites próprios. Em 429, respeite o cabeçalho de nova tentativa quando houver ou aguarde progressivamente. Não repita escritas automaticamente, pois podem duplicar dados ou cobrar novamente ações de IA.