Guia de integração
Erros e suporte
Falhas são retornadas com o status HTTP e um corpo `application/problem+json`. O campo `code` é estável; `title` e `detail` são textos destinados a explicar a ocorrência.
Exemplo
{
"type": "https://api-docs.weesy.com.br/problems/servico-nao-encontrado",
"title": "Serviço não encontrado",
"status": 404,
"code": "servico_nao_encontrado",
"detail": "Não há serviço ativo com o id informado para este emissor.",
"traceId": "<TRACE_ID_DA_RESPOSTA>"
}Estrutura da resposta
Erros de validação podem incluir erros[], com caminho do campo, código e mensagem. A pilha interna e detalhes de infraestrutura não fazem parte da resposta pública.
Como tratar
Trate por status HTTP e code, não compare o texto de detail. Em 400 corrija a entrada; em 401 renove ou valide a credencial; em 403 confira a permissão; em 404 confirme o identificador e o alcance; em 409 consulte o estado atual antes de repetir; em 429 respeite Retry-After; em 503 tente novamente com espera progressiva.
Como pedir ajuda
Registre traceId, horário UTC, endpoint, método, status e code. Remova tokens, dados pessoais e conteúdo fiscal sensível dos logs antes de compartilhar. O canal oficial e o SLA de suporte serão publicados quando confirmados.
Observação: O exemplo é ilustrativo. Use o traceId real da resposta ao abrir uma solicitação de suporte.