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
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
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"
}
Refresh token.
Permite gerar um novo token com base no token expirado. (Útil para casos onde o token expirou e o operador do serviço deseja obter um novo token sem precisar realizar uma nova autenticação completa).
⚠️ ATENÇÃO: O token expirado não pode ter um prazo de expiração superior a 2 horas.
post
Body
Body
Dados do token expirado.
AtualizarTokenInputModel
Dados para atualização do token expirado.
* Additional properties are NOT allowed.
tokenstringrequired
Token expirado.
>= 1 characters
Response
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/AtualizarToken
Body
{
"token": "token"
}
Emissor
Controlador responsável pela gestão de Emissores vinculados aos aplicativos da Stone Tax API.
Fornece operações para habilitação, atualização e desabilitação de emissores fiscais,
permitindo a configuração detalhada de entidades que realizam a emissão de documentos na plataforma.
Por meio desta controller é possível administrar os dados cadastrais, regimes tributários e tipos de estabelecimento,
além de oferecer recursos avançados de listagem paginada e consulta de detalhes
filtrando por documentos, status e períodos de criação.
Todos os recursos disponibilizados exigem autenticação e são vinculados ao contexto do
Parceiro e Aplicativo autenticados, garantindo isolamento de dados e conformidade
com as regras de negócio fiscais.
Habilitar emissor.
Permite habilitar um novo emissor para uso na aplicação. Para realização de consultas da tributação dos produtos e emissão de notas fiscais é fundamental o credenciamento do emissor.
⚠️ ATENÇÃO: É necessário que os dados cadastrais do emissor estejam corretos e atualizados para retorno assertivo da tributação dos produtos nas consultas e emissão de notas fiscais.
post
Body
Body
Dados necessários para habilitar o emissor.
HabilitarEmissorInputModel
Dados de entrada para habilitar o emissor.
* Additional properties are NOT allowed.
documentostring | null
Documento (CPF/CNPJ) do emissor.
tipoDocumentostringrequired
Tipo de documento do emissor.
Allowed values:CpfCnpj
nomestringrequired
Nome ou Razão Social do emissor.
>= 3 characters<= 60 characters
nomeFantasiastring | null
Nome fantasia do emissor.
regimeTributariostringrequired
Regime tributário do emissor.
Allowed values:MeiSimplesNacionalSimplesNacionalExcessoReceitaLucroPresumidoLucroReal
aliquotaCreditoSimplesnumber | null(double)
Alíquota do crédito de icms do simples nacional consedido em operações de revenda do regime Simples Nacional.
tipoIcmsStstringrequired
Tipo de ICMS ST do emissor.
Allowed values:SubstitutaSubstituida
tipoEstabelecimentostringrequired
Tipo de estabelecimento do emissor quanto ao IPI.
Allowed values:OutrosIndustriaOuEquiparado
telefonestring | null
Telefone de contato.
>= 6 characters<= 14 characters
inscricaoMunicipalstring | null
Inscrição municipal do emissor.
<= 15 characters
cnaestring | null
Código CNAE principal.
<= 7 characters
cnaeSecundariostring | null
Código CNAE secundário.
<= 7 characters
enderecoobjectrequired
Dados do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
inscricoesEstaduaisarray | null[object]
Dados da inscrição estadual e identificação do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
Response
Response
No Content
post/api/v1/Emissor/Habilitar
Authentication
Body
{
"tipoDocumento": "Cpf",
"nome": "nome",
"regimeTributario": "Mei",
"tipoIcmsSt": "Substituta",
"tipoEstabelecimento": "Outros",
"endereco": {
"logradouro": "logradouro",
"numero": "numero",
"bairro": "bairro",
"codigoMunicipio": "codigoMunicipio",
"municipio": "municipio",
"cep": "cep"
}
}