API de Integração HAASS
Referência dos endpoints de onboarding de parceiro. Comece pela autenticação e siga para os recursos que for integrar.
Áreas
| Área | O que cobre |
|---|---|
| Autenticação | OAuth 2.0 (Client Credentials) e uso do token Bearer nas demais rotas. |
| Organization | Estrutura organizacional: Company, BusinessUnit, FranchiseGroup e Store. |
| Catálogo | Produtos, SKUs, marcas, preço, estoque, cargas em massa (bulk) e atributos/templates. |
Convenções
- Autenticação: toda rota (exceto a emissão do token) exige o cabeçalho
Authorization: Bearer <access_token>. Veja Autenticação. idvsrefId:idé a chave interna da HAASS;refIdé a sua chave de negócio.- Atualizar por
idourefId: os recursos podem ser lidos e atualizados pela chave interna (id) ou pela sua chave de negócio (refId, rota/by-ref/{refId}). A atualização exige um registro existente — retorna404se a chave não for encontrada. - Criar: use a rota de criação (
POST), comrefIdopcional no corpo. - Paginação por cursor: listagens usam
cursor+take; percorra enviandocursor=iddo último item atéhasMore=false. - Bulk assíncrono: cargas em massa retornam
202com umrequestIde reportam o resultado por webhook nacallbackUrl.
Exemplos de curl
Cada endpoint traz uma aba cURL pronta para copiar. Os exemplos usam duas variáveis de ambiente — defina-as antes de rodar:
export HAASS_API="https://api.haass.com.br" # URL base do ambiente (homolog/prod)
export TOKEN="<access_token>" # obtido em Autenticação
POC
Documentação gerada a partir das specs de integração (023–025). Os contratos descrevem a casca dos endpoints (request/response de exemplo) para o parceiro iniciar a integração antes da implementação final.