Stone Tax API

1.0.0OAS 3.0

A Stone Tax API é a solução fiscal da Stone responsável por atuar como middleware entre o portfólio de produtos da companhia e os serviços de documentos fiscais (SEFAZ e prefeituras), oferecendo uma integração simples, segura, performática e padronizada.

Seu objetivo é permitir que os produtos cumpram as obrigações acessórias do fisco brasileiro de forma mais eficiente e desacoplada, centralizando regras, reduzindo complexidade e promovendo reutilização de soluções fiscais dentro do ecossistema Stone.

Além de recursos de credenciamento, autenticação e emissão/gestão de documentos fiscais (como NF-e, NFC-e e NFS-e), a API disponibiliza capacidades como Catálogo Fiscal e suporte inteligente ao preenchimento tributário, auxiliando no cálculo e composição de tributos da venda de forma automática e consistente.

A API é construída em .NET 8 e projetada com base nos princípios de DDD, EDA e CQRS, com execução de tarefas agendadas via Hangfire.

A documentação completa do projeto encontra-se em Documentação Completa.

A documentação destinada às aplicações encontra-se em Documentação da aplicação.

Contextos de Negócio

  • Autenticação: provê recursos para autenticar usuários do Console e Aplicativos, incluindo emissão e gestão de credenciais e tokens.
  • Console: provê recursos para criação e gerenciamento de Parceiros e Aplicativos, além de configurações operacionais e administrativas.
  • Emissor: provê recursos para habilitação e gestão cadastral de emissores, permitindo o controle de regimes tributários e configurações operacionais vinculadas a parceiros e aplicativos.
  • Catálogo Fiscal: provê recursos para consulta e listagem de produtos por EAN e descrição, incluindo consulta fiscal detalhada por EAN.
  • NF-e: provê recursos para emissão e gestão de NF-e, incluindo listagem, detalhamento, consultas e obtenção de documentos como DANFE.
  • NFC-e: provê recursos para emissão e gestão de NFC-e, incluindo listagem, detalhamento, consultas e obtenção de documentos como DANFE.
  • NFS-e: provê recursos para emissão e gestão de NFS-e, incluindo listagem, detalhamento, consultas e retorno de documentos conforme o padrão de cada município.
API Base URL
  • Server 1:https://stone-tax-sdx.stone.com.br

    Ambiente de Desenvolvimento

  • Server 2:https://stone-tax.stone.com.br

    Ambiente de Produção

Security
BearerAuth (http)

Autenticação via token JWT. Obtenha o token através do endpoint /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.

Autenticacao

Controlador responsável pelos processos de autenticação e autorização de acesso à Stone Tax API.

Fornece recursos para que o Console e os Aplicativos realizem a autenticação
na API por meio de credenciais de segurança, garantindo acesso seguro aos serviços disponíveis.

Também disponibiliza mecanismos para renovação/atualização de tokens de acesso,
permitindo a continuidade da comunicação mesmo após a expiração do token atual,
sem necessidade de uma nova autenticação completa.

Obter token.

Permite obter o token de acesso a api com base nas credenciais fornecidas pelo operador do serviço.

⚠️ ATENÇÃO: O token tem validade de 1 hora. É sugerido armazenar o token em cache para evitar geração de tokens em excesso sobrecarregando o serviço.

post

Body

Credenciais de acesso.

GerarTokenInputModel

Dados para gerar token de acesso.

* Additional properties are NOT allowed.
clientIdstringrequired

Identificador do cliente da requisição.

>= 1 characters

secretIdstringrequired

Senha do cliente da requisição.

>= 1 characters

Response

OK

GerarTokenViewModel

Informação de retorno da autenticação.

* Additional properties are NOT allowed.
tokenstring | null

Token de acesso.

expiresIninteger(int32)

Tempo de expiração do token (segundos).

refreshExpiresIninteger(int32)

Tempo de expiração do token para gerar nova sessão (segundos).

post/api/v1/Autenticacao/ObterToken

Body

{ "clientId": "clientId", "secretId": "secretId" }