Através deste endpoint, é possível criar uma licença nova ou realizar alterações nas informações de uma licença existente.
Salvar Dados
URL
POST https://painelapi.ns.eti.br/licenca/salvarDados
Dados de entrada
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso | 1-1 | A | Token de acesso da Software House utilizada para comunicação com as APIS da NS Tecnologia. Pode ser informado no header da requisição | |
| licencas | Objeto que contém os dados de licença | 1-1 | Array | ||
| situacao | Código de situação da licença | 1-1 | N | licencas | 0 - Testes; 1 - Produção; 2 - Bloqueado |
| envia_email_sendgrid | Ativa o envio de email pelo sendgrid | 0-1 | N | licencas | Enviar campo como: true. Valor padrão: False |
| liberado | Código do tipo de liberação da Licença | 0-1 | N | licencas | 0 - Não Liberado; 1 - Liberado; 2 - Descartado |
| usarcertns | Se deve ser utilizado o certificado da SH para transmissão dos dados | 0-1 | B | licencas | Obrigatório valor true quando emitente utilizar assinatura local ou Client Suite. Valor padrão: False |
| manifesta_auto | Ativa manifestação automática de Ciência da Operação para liberar o downloaddos XMLs completos de NF-e. | 0-1 | B | licencas | Somente para projeto DDF-e Valor padrão: False |
| buscacte | Habilita o download de CT-es emitidos contra o CNPJ desta licença. | 0-1 | B | licencas | Somente para projeto DDF-e. Por padrão, apenas o download de NF-e é habilitado. Para habilitar a consulta de CT-es disponíveis contra este CNPJ na Sefaz é necessário enviar true neste campo. Valor padrão: False |
| buscanfse | Habilita o download de NFS-es emitidos contra o CNPJ desta licença. | 0-1 | B | licencas | Somente para projeto DDF-e. Por padrão, apenas o download de NF-e é habilitado. Para habilitar a consulta de NFS-es disponíveis contra este CNPJ na Sefaz é necessário enviar true neste campo. Valor padrão: False |
| receber90dias | Indicador se devem ser buscados os DF-es emitidos contra a empresa | 0-1 | B | licencas | Somente para projeto DDF-e. OBS: Se você escolher 'True', ao cadastrar a licença, baixaremos da Sefaz os documentos de forma retroativa, ou seja, todas as notas disponíveis dos últimos 90 dias. Se optar por 'False', baixaremos apenas os arquivos disponíveis a partir do dia do cadastro da licença. Esta opção pode gerar acréscimo no plano solicitado. Para mais informações contate o seu consultor comercial. |
| idprojeto | Código identificador do projeto | 1-1 | B | licencas | 1 - NS NFe; 6 - NS CTe; 20 - NS NFCe; 21 - NS MDFe; 22 - NS DDFe; 23 - NS Portal; 24 - NS SAT; 26 - CTe OS. |
| pessoa | Objeto contendo os dados da empresa vinculada a licença | 1-1 | Object | ||
| cnpj | CNPJ da empresa | 1-1 | A | pessoa | |
| ie | Inscrição estadual | 0-1 | A | pessoa | |
| razao | Razão social da empresa | 1-1 | A | pessoa | |
| fantasia | Nome fantasia da empresa | 0-1 | A | pessoa | |
| tpicms | Tipo de ICMS | 1-1 | N | pessoa | 1 - Contribuinte ICMS; 2 - Contribuinte ISENTO de Inscrição no Cadastro de Contribuintes do ICMS; 9 - Não Contribuinte |
| site | Site da empresa | 0-1 | A | pessoa | |
| datanasc | Data de nascimento | 0-1 | D | pessoa | Formato DD/MM/YYYY |
| skype | Usuário do Skype | 0-1 | A | pessoa | |
| emails | Objeto contendo o email da empresa | 0-1 | Array | pessoa | |
| Endereço de e-mail | 1-1 | A | emails | ||
| enderecos | Objeto contendo os dados de endereço da empresa | 1-1 | Array | pessoa | |
| endereco | Logradouro | 1-1 | A | enderecos | |
| numero | Número do endereço | 1-1 | N | enderecos | |
| bairro | Bairro do endereço | 1-1 | A | enderecos | |
| cep | Código postal | 1-1 | N | enderecos | Apenas números |
| cidade | Objeto contendo o identificador da cidade onde a empresa está localizada | 1-1 | O | enderecos | |
| cIBGE | Código de IBGE da cidade | 1-1 | N | cidade | Baixe aqui um XML com os códigos IBGEs das cidades |
| nome | Nome da cidade | 1-1 | A | cidade | |
| telefones | Objeto contendo o telefone da empresa | 1-1 | Array | pessoa | |
| numero | Número do telefone | 1-1 | N | telefones | Máximo de 14 caracteres |
| csc | Objeto contendo as informações de csc da empresa | 0-1 | Array | licenca | |
| csc | Identificador Código de Segurança do Contribuinte | 1-1 | A | csc | |
| codcsc | Código de Segurança do Contribuinte | 1-1 | A | csc | Máximo de 6 digitos. |
| tpamb | Tipo de ambiente ao qual as informações se referem | 1-1 | N | csc | 1 - Produção; 2 - Homologação |
| certificado | Objeto contendo os dados do certificado digital da empresa | 0-1 | O | licenca | Obrigatório caso o projeto seja 22 - NS DDFe |
| certificado | Criptografia Base64 do arquivo do certificado | 1-1 | A | certificado | |
| senha | Senha do certificado | 1-1 | A | certificado | |
| emailenvio | Objecto contendo os dados de configuração para disparar e-mail automático | 0-1 | O | licenca | |
| servidor | Endereço do servidor SMTP | 1-1 | A | emailenvio | |
| porta | Porta de acesso do servidor SMTP | 1-1 | N | emailenvio | |
| ssl | Indicador se deve ser utilizada conexão segura(SSL) | 1-1 | N | emailenvio | Possíveis valores: 0 - Não; 1 - Sim |
| confirmaleitura | Indicador se deve ser recebido o e-mail de confirmação de leitura | 1-1 | N | emailenvio | Possíveis valores: 0 - Não; 1 - Sim |
| usuario | Login do e-mail | 1-1 | A | emailenvio | |
| senha | Senha do e-mail | 1-1 | A | emailenvio | |
| from | E-mail do remente, para quando e-mail do remetente diferente do e-mail de login no servidor | 0-1 | A | emailenvio | |
| anexardocoriginal | Indicador se deve ser enviado o documento original junto nos envios de eventos | 0-1 | B | emailenvio | Valor padrão: false |
| anexarpdf | Indicador se deve ser anexado o PDF | 0-1 | B | emailenvio | Valor padrão: false |
| semcorpo | Indicador se os e-mails devem ser enviados sem corpo, apenas anexos | 0-1 | B | emailenvio | Valor padrão: false |
| logotipo | Objeto contendo o logo da empresa | 0-1 | Array | licença | |
| arquivo | Criptografia Base64 do arquivo do logo | 1 - 1 | A | logotipo | |
| omitir_dadosemitente | Permite que o Documento Auxiliar dos DF-es seja impresso sem as informações do emitente | 1 - 1 | B | logotipo | Apenas NFe. Valor padrão: false |
| aceite_dadosemitente | Se o campo "omitir_dadosemitente" for informado com valor *true*, este campo também deve ser enviado com valor *true*, como confirmação de que você aceita os *Termos e condições de omissão dos dados do emitente*. Do contrário, os dados não serão omitidos. | 1 - 1 | B | logotipo | Apenas NFe. Valor padrão: false |
Exemplo de JSON de cadastro de licenças
{
"licencas": [
{
"situacao": 0,
"envia_email_sendgrid": true,
"idprojeto": 1,
"certificado": {
"certificado": "BASE64 DO CERTIFICADO",
"senha": "SENHA DO CERTIFICADO"
},
"emailenvio": {
"servidor": "SERVIDOR DO EMAIL",
"porta": "587",
"ssl": 0,
"confirmaleitura": 0,
"usuario": "USUARIO",
"senha": "SENHA DO EMAIL",
"from": "emailParaEnvioDosDocumentos@teste.com",
"anexardocoriginal": true,
"anexarpdf": true
},
"logotipo": [
{
"arquivo": "BASE 64 DA IMAGEM DO LOGO",
"omitir_dadosemitente": false,
"aceite_dadosemitente": false
}
]
},
{
"situacao": 0,
"idprojeto": 1,
"certificado": {
"certificado": "BASE64 DO CERTIFICADO",
"senha": "SENHA DO CERTIFICADO"
},
"emailenvio": {
"servidor": "SERVIDOR DO EMAIL",
"porta": "587",
"ssl": 0,
"confirmaleitura": 0,
"usuario": "USUARIO",
"senha": "SENHA DO EMAIL",
"from": "emailParaEnvioDosDocumentos@teste.com",
"anexardocoriginal": true,
"anexarpdf": true
},
"logotipo": [
{
"arquivo": "BASE 64 DA IMAGEM DO LOGO",
"omitir_dadosemitente": false,
"aceite_dadosemitente": false
}
]
},
{
"situacao": 0,
"idprojeto": 1,
"certificado": {
"certificado": "BASE64 DO CERTIFICADO",
"senha": "SENHA DO CERTIFICADO"
},
"emailenvio": {
"servidor": "SERVIDOR DO EMAIL",
"porta": "587",
"ssl": 0,
"confirmaleitura": 0,
"usuario": "USUARIO",
"senha": "SENHA DO EMAIL",
"from": "emailParaEnvioDosDocumentos@teste.com",
"anexardocoriginal": true,
"anexarpdf": true
},
"logotipo": [
{
"arquivo": "BASE 64 DA IMAGEM DO LOGO",
"omitir_dadosemitente": false,
"aceite_dadosemitente": false
}
]
},
{
"situacao": 0,
"idprojeto": 1,
"certificado": {
"certificado": "BASE64 DO CERTIFICADO",
"senha": "SENHA DO CERTIFICADO"
},
"emailenvio": {
"servidor": "SERVIDOR DO EMAIL",
"porta": "587",
"ssl": 0,
"confirmaleitura": 0,
"usuario": "USUARIO",
"senha": "SENHA DO EMAIL",
"from": "emailParaEnvioDosDocumentos@teste.com",
"anexardocoriginal": true,
"anexarpdf": true
},
"logotipo": [
{
"arquivo": "BASE 64 DA IMAGEM DO LOGO",
"omitir_dadosemitente": false,
"aceite_dadosemitente": false
}
]
}
],
"pessoa": {
"cnpj": "CNPJ DO EMITENTE",
"ie": "IE DO EMITENTE",
"razao": "RAZAO SOCIAL DO EMITENTE",
"fantasia": "NOME FANTASIA DO EMITENTE",
"tpicms": 1,
"emails": [
{
"email": "emailDoEmitente@teste.com"
}
],
"enderecos": [
{
"endereco": "Rua Teste 01",
"numero": "999",
"bairro": "Bairo de Teste",
"cep": "38500000",
"cidade": {
"cIBGE": "3143104"
}
}
],
"telefones": [
{
"numero": "51999999999"
}
]
}
}
Exemplo de requisição
curl -X POST
\-H "Content-Type: application/json"
\-d '{"X-AUTH-TOKEN": "SEU_TOKEN", "licencas": [{ ... }], "pessoa": {...} }' https://painelapihml.ns.eti.br/licenca/addLicense
Dados retornados
| Campo | Descrição | Observação |
|---|---|---|
| status | Código de status do processamento | |
| msg | Descrição literal do status de processamento | |
| erro | Erro que ocorreu no processamento | Apenas em status diferente de 200 |
| validacao | Descrição do problema de validação | Apenas quando o erro for de campo com valor inválido |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"msg": "Dados da licença salvos com sucesso"
}
Retorno com erro
{
"status": -2,
"msg": "Erro para salvar dados da licença",
"erro": "Problemas na validação de Dados",
"validacao": "A Situacao da Licenca, Somente aceita os seguintes valores 0 = Homologação, 1 = Producao ou 2 = Bloqueado"
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Dados da licença salvos com sucesso |
| -1 | Informações obrigatórias não informadas |
| -11 | Erro interno ao processar requisição |
| -12 | Erro para salvar dados da licença |
Termos e Condições de Omissão dos Dados do Emitente
Por definição da Secretaria da Fazenda, o Documento Auxiliar (PDF) do DF-e deve conter, obrigatoriamente, a identificação do emitente, composta por no mínimo: Nome ou razão social; endereço completo (logradouro, número, complemento, bairro, município, UF e CEP); telefone. Ao optar por "Omitir dados do emitente", o Documento Auxiliar dos DF-es será impresso sem essas informações. Todavia, você declara e assume a responsabilidade de que o logo inserido acima contém todas as informações citadas anteriormente, de forma legível.