Gera URLs pré-assinadas que permitem salvar documentos fiscais eletrônicos (como notas fiscais) diretamente na Amazon Web Services (AWS). O endpoint retorna uma lista de URLs que fornecem acesso a um bucket da AWS, onde os arquivos devem ser armazenados. É responsabilidade do solicitante utilizar essas URLs para enviar os arquivos à AWS.
\n- \n
Autenticação:
\n- \n
- Utiliza o token de acesso junto com o token de parceiro. \n
\n
Códigos de Status:
\n- \n
200 OK: Requisição bem-sucedida, e o arquivo foi encontrado na base de dados.
\n \n404 Não Encontrado: Arquivo não encontrado na base de dados.
\n \n400 Formato Incorreto: Formato de requisição ou dados incorretos.
\n \n
Parâmetros Obrigatórios (enviados no corpo da requisição):
\n- \n
- {nomeArquivo} - Lista de nomes de arquivos associados ao documento fiscal (array de strings). \n
Uso do Endpoint:
\nPara utilizar este endpoint, siga os seguintes passos:
\n- \n
Obtenção das URLs:
\n
Faça uma requisição ao endpoint para receber a lista de URLs pré-assinadas. \nEnvio dos Arquivos:
\n
Utilize cada URL recebida para fazer uma requisição via método PUT, enviando no corpo da requisição apenas o conteúdo do arquivo que deseja salvar. \n
Token do sistema ERP
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"cnpj\": \"{{cnpj}}\",\r\n \"nomeArquivo\": [\r\n \"Gera URLs pré-assinadas que permitem salvar documentos fiscais eletrônicos (como notas fiscais) diretamente na Amazon Web Services (AWS). O endpoint retorna uma lista de URLs que fornecem acesso a um bucket da AWS, onde os arquivos devem ser armazenados. É responsabilidade do solicitante utilizar essas URLs para enviar os arquivos à AWS.
\n- \n
Autenticação:
\n- \n
- Utiliza o token de acesso junto com o token de parceiro. \n
\n
Códigos de Status:
\n- \n
200 OK: Requisição bem-sucedida, e o arquivo foi encontrado na base de dados.
\n \n404 Não Encontrado: Arquivo não encontrado na base de dados.
\n \n400 Formato Incorreto: Formato de requisição ou dados incorretos.
\n \n
Parâmetros Obrigatórios (enviados no corpo da requisição):
\n- \n
{cnpj} - CNPJ da Empresa (string) ou {empresaId} - Código da Empresa (integer).
\n \n{nomeArquivo} - Lista de nomes de arquivos associados ao documento fiscal (array de strings).
\n \n
Uso do Endpoint:
\nPara utilizar este endpoint, siga os seguintes passos:
\n- \n
Obtenção das URLs:
\n
Faça uma requisição ao endpoint para receber a lista de URLs pré-assinadas. \nEnvio dos Arquivos:
\n
Utilize cada URL recebida para fazer uma requisição via método PUT, enviando no corpo da requisição apenas o conteúdo do arquivo que deseja salvar. \n
A API Integra NET foi criada para simplificar e otimizar o envio de documentos fiscais, oferecendo uma solução eficiente e segura para o upload desses arquivos no Amazon S3.
\nEssa API foi desenvolvida e é gerenciada pela SCI, porém a integração com ela é de responsabilidade dos clientes ou parceiros comerciais, que têm interesse em implementá-la conforme suas necessidades.
\n1.Visão Geral
\nA API Integra NET permite:
\n- \n
- Armazenar documentos fiscais: Faz o upload de documentos diretamente para o Amazon S3 de forma segura através de URLs. \n
2.Recursos e Benefícios
\n- \n
Escalabilidade: Ideal para empresas de todos os portes, com a capacidade de crescer conforme suas necessidades aumentam.
\n \nSegurança: Integrada com a AWS, garantindo que seus documentos sejam armazenados e transferidos de maneira segura.
\n \nFlexibilidade: Pode ser utilizada tanto por escritórios de contabilidade quanto por seus clientes, adaptando-se a diferentes cenários de uso.
\n \n
3.Como Usar Esta Documentação
\nNesta documentação, você encontrará:
\n- \n
Referências de Endpoints: Descrição detalhada de cada endpoint disponível, incluindo métodos HTTP, parâmetros necessários, e exemplos de respostas.
\n \nExemplos de Uso: Códigos de exemplo para facilitar a implementação .
\n \nGuia de Autenticação: Instruções para configurar e utilizar tokens de autenticação para acessar a API.
\n \n
URLs Base
\n- \n
- Ambiente de Produção:
URL Base:https://api-integranet.sci.com.br\n
4.Autenticação
\nPara acessar os endpoints da API Integra NET, todas as solicitações devem ser autenticadas com um Token de Acesso do tipo Bearer, obtido por meio do SCI WEB, e incluído no cabeçalho da requisição para garantir a autenticação correta.
\nPara gerar esse token, acesse as opções no canto superior direito do SCI WEB, seja pelo módulo Administrador ou pelo módulo Cliente, conforme demonstrado nos prints abaixo.
\nSó é possível obter o token em ambiente oficial (produção), sendo necessário ter os respectivos módulos contratados junto à SCI.
\nObservação: O token poderá ser visualizado de forma completa apenas na hora da criação
\nEste Token de Acesso pode ser de dois tipos: \"contabilidade\" (gerado pelo acesso admin do SCI WEB por usuários dos tipos Diretor e TI) ou \"empresa\" (gerado pelo acesso do cliente do SCI WEB). Um token de contabilidade permite que sejam enviados notas para todas as empresas da contabilidade vinculadas ao token, ao utilizá-lo será necessário especificar a qual empresa o documento fiscal pertence, informando o código ou CNPJ da empresa. Enquanto um token de empresa permite que sejam enviados documentos apenas para a empresa que gerou o token, ao ser utilizado vincularemos os documentos automaticamente a empresa associada ao token, sem a necessidade de ser informado na requisição o código ou CNPJ da empresa.
\nAlém disso, também será necessário um Token de Parceiro que deve ser solicitado através do site https://sci.com.br/sistemas-de-gestao/ com as seguintes informações:
\n- \n
Nome da empresa
\n \nCNPJ da empresa
\n \nMunicípio e estado
\n \nCódigo de cliente SCI (informe se não for cliente)
\n \nRegião de atuação
\n \n
Como Utilizar o Token de Acesso
\nO Token de Acesso deve ser passado no cabeçalho da requisição HTTP conforme o exemplo abaixo:
\nToken de Parceiro
\nSerá necessário fornecer um Token de Parceiro junto com o Token de Acesso. Esse token adicional deve ser incluído no cabeçalho da requisição, conforme o exemplo:
\nEstrutura dos Endpoints
\nOs endpoints possuem uma estrutura base construída conforme o padrão:
\n{urlBase}/api/{tipoDocumento}
Tipos de Documentos
\nO tipo de documento deve ser informado conforme as opções abaixo:
\n- \n
nfe
\n \nnfce
\n \ncte
\n \ncfe
\n \ncat52
\n \nsintegra
\n \ntxt (layout padrão SCI)
\n \nsped
\n \n
Estruturas de URL por Tipo de Documento
\nNFE-NFCE-CTE-CFE-TXT
\nEsses tipos de documentos compartilham a mesma estrutura de URL para as operações de busca e upload. O endpoint de atualização é o mesmo para todos.
\nExemplos de URLs:
\n- \n
Buscar documento:
\n{urlBase}/api/{tipoDocumento}/{tipoMovimentacao}?clienteId={clienteId}&empresaId={empresaId}&dataIni={dataIni}&dataFim={dataFim}&page={page}\nAtualizar status:
\n{urlBase}/api/{tipoDocumento}/{tipoMovimentacao}\nSalvar documento:
\n{urlBase}/api/{tipoDocumento}\n
CAT52-SINTEGRA-SPED
\nEsses tipos de documentos compartilham uma estrutura de URL similar para as operações de busca e upload. O endpoint de atualização é o mesmo para todos.
\nExemplos de URLs:
\n- \n
Buscar documento:
\n{urlBase}/api/{tipoDocumento}/{clienteId}?empresaId={empresaId}&dataIni={dataIni}&dataFim={dataFim}&page={page}\nAtualizar status:
\n{urlBase}/api/{tipoDocumento}/{clienteId}\nSalvar documento:
\n{urlBase}/api/{tipoDocumento}\n
Tipos de Movimentação
\nEm alguns endpoints, também é necessário informar o tipo de movimentação:
\n{urlBase}/api/{tipoDocumento}/{tipoMovimentacao}
Opções de Movimentação (exceto para o tipo de documento TXT):
\n- \n
entrada
\n \nsaida
\n \n
Movimentações Específicas para Documento TXT (layout padrão SCI)
\nO documento do tipo txt possui tipos específicos de movimentação:
\n- \n
ecc: Clientes
\n \necf: Fornecedores
\n \necp: Produtos
\n \n- \n \n
ens: Movimento de saídas
\n \n- \n \n
- \n \n
- \n \n
eie: Inventário
\n \netx: Impostos
\n \netp: Impostos pagos
\n \n
Nome do arquivo em padrão obrigatório:
\nApós definir o código da movimentação (conforme tabela apresentada acima), o arquivo deve seguir a seguinte estrutura:
\n1- Código da movimentação
Utilizar um dos códigos definidos na tabela (ex.: ecc, ecf, ecp, etc.), que identifica o tipo de informação contida no arquivo.
2- CNPJ da empresa
Logo após o código, deve ser informado o CNPJ da empresa referente aos dados do arquivo TXT.
O CNPJ deve ser informado apenas com números, sem pontos, barras ou traços.
3- Data e hora de geração
Após o CNPJ, deve ser informada a data e hora completas da geração do arquivo.
- \n
A data e hora devem estar no formato contínuo, sem espaços, barras ou dois pontos.
\n \nO padrão utilizado é: AAAAMMDDHHMMSS
\n \n
Exemplo de conversão de data:
\nData original:2023/11/22 17:26:00
Data no formato exigido:20231122172600
Exemplo completo de sequência:
\necc + CNPJ + datahora\necc1234567800019920231122172600\n\n5.Categorias
\nExistem três tipos de categorias de usuários: Interno, Contabilidade e Empresa. Cada categoria possui sua própria configuração referente aos tokens informados e aos campos obrigatórios nos endpoints.
\nInterno
\nA categoria \"Interno\" é destinada exclusivamente para as aplicações internas da SCI Sistemas Contábeis. Essa categoria permite uma maior flexibilidade na busca e manipulação de dados dos usuários, com algumas regras específicas a serem seguidas:
\n- \n
Autenticação:
\n- \n
Utiliza apenas o token de acesso.
\n \nO token de acesso deve pertencer a um dos seguintes grupos de token da api-Auth:
\n- \n
web
\n \nunico
\n \nvisual
\n \npush
\n \nsubsistema
\n \n
\n
\n
Contabilidade
\nA categoria \"Contabilidade\" é destinada aos escritórios de contabilidade, permitindo que acessem e gerenciem os dados fiscais de seus clientes.
\n- \n
Autenticação:
\n- \n
Utiliza o token de acesso junto com o token de serviço.
\n \nO token de acesso deve pertencer ao grupo de token da api-Auth:
\n- \n
- contabilidade \n
\nO token de serviço (token de parceiro) deve pertencer ao grupo de token da api-Auth:
\n- \n
- erp \n
\n
\n
Empresa
\nA categoria \"Empresa\" é destinada aos clientes dos escritórios de contabilidade, permitindo que as empresas acessem e gerenciem exclusivamente seus próprios dados.
\n- \n
Autenticação:
\n- \n
Utiliza o token de acesso junto com o token de serviço.
\n \nO token de acesso deve pertencer ao grupo de token da api-Auth:
\n- \n
- empresa \n
\nO token de serviço (token de parceiro) deve pertencer ao grupo de token da api-Auth:
\n- \n
- erp \n
\n
\n
Arquivo de lançamentos contábeis (.txt)
\n","type":"file","value":null},{"key":"documento","value":"{{documento}}","description":"CNPJ da empresa
\n","type":"text"},{"key":"data_inicial","value":"{{dataIni}}","description":"Data inicial do período
\n","type":"text"},{"key":"data_final","value":"{{dataFim}}","description":"Data final do período
\n","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis","urlObject":{"path":["api","{{versao}}","lancamentos-contabeis"],"host":["{{urlBase}}"],"query":[],"variable":[]}},"response":[{"id":"c6991f46-3f7a-4e55-81c6-e36a632c8bf7","name":"Sucesso - Arquivo importado","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"anexo","type":"file","src":[]},{"key":"documento","value":"13639455000101","type":"text"},{"key":"data_inicial","value":"2024-09-01","type":"text"},{"key":"data_final","value":"2024-09-30","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Lançamento importado com sucesso!\"\r\n}"},{"id":"d48ca727-5437-4894-bd30-30c14af4872c","name":"Sucesso - O arquivo para o mesmo período foi atualizado","originalRequest":{"method":"POST","header":[{"key":"service-Token","value":"{{tokenServico}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"anexo","description":"Arquivo de lançamentos contábeis (.txt)","type":"file","value":null},{"key":"documento","value":"{{documento}}","description":"CNPJ da empresa","type":"text"},{"key":"data_inicial","value":"{{dataIni}}","description":"Data inicial do período","type":"text"},{"key":"data_final","value":"{{dataFim}}","description":"Data final do período","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Arquivo atualizado com sucesso!\"\n}"},{"id":"f9adc014-ec8b-4b27-a4e0-cf336e7639ae","name":"Erro - Dados inválidos","originalRequest":{"method":"POST","header":[{"key":"service-Token","value":"{{tokenServico}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"anexo","description":"Arquivo de lançamentos contábeis (.txt)","type":"file","value":null},{"key":"documento","value":"1985272100015","description":"CNPJ da empresa","type":"text"},{"key":"data_inicial","value":"2024-10-04","description":"Data inicial do período","type":"text"},{"key":"data_final","value":"2024-10-03","description":"Data final do período","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"anexo\": [\n \"O arquivo deve ter nome padrão SCI e também ser do tipo .txt. \"\n ],\n \"documento\": [\n \"O campo documento deve ter 14 digitos\"\n ],\n \"data_final\": [\n \"A data final deve ser maior que a data inicial.\"\n ]\n }\n}"},{"id":"01661936-9640-4933-aa16-353983218d17","name":"Erro - Um arquivo para o mesmo período já foi integrado com o Único","originalRequest":{"method":"POST","header":[{"key":"service-Token","value":"{{tokenServico}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"anexo","description":"Arquivo de lançamentos contábeis (.txt)","type":"file","value":null},{"key":"documento","value":"{{documento}}","description":"CNPJ da empresa","type":"text"},{"key":"data_inicial","value":"{{dataIni}}","description":"Data inicial do período","type":"text"},{"key":"data_final","value":"{{dataFim}}","description":"Data final do período","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Arquivo com período informado já foi importado.\"\n}"},{"id":"446058e1-a00d-4fcc-8c0e-76e9f18f1db6","name":"Erro - Empresa não cadastrada na web","originalRequest":{"method":"POST","header":[{"key":"service-Token","value":"{{tokenServico}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"anexo","description":"Arquivo de lançamentos contábeis (.txt)","type":"file","value":null},{"key":"documento","value":"{{documento}}","description":"CNPJ da empresa","type":"text"},{"key":"data_inicial","value":"{{dataIni}}","description":"Data inicial do período","type":"text"},{"key":"data_final","value":"{{dataFim}}","description":"Data final do período","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Não existe empresa com este documento cadastrada na web.\"\n}"},{"id":"4ef756ea-9711-4ac6-88bb-7b590c31a7fc","name":"Erro - Token de acesso ou serviço é inválido","originalRequest":{"method":"POST","header":[{"key":"service-Token","value":"{{tokenServico}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"anexo","description":"Arquivo de lançamentos contábeis (.txt)","type":"file","value":null},{"key":"documento","value":"{{documento}}","description":"CNPJ da empresa","type":"text"},{"key":"data_inicial","value":"{{dataIni}}","description":"Data inicial do período","type":"text"},{"key":"data_final","value":"{{dataFim}}","description":"Data final do período","type":"text"}]},"url":"{{urlBase}}/api/{{versao}}/lancamentos-contabeis"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Não possui credenciais válidas para o recurso solicitado\"\n}"}],"_postman_id":"24786fb3-4932-451e-aa84-633a933fe85e"}],"id":"a055c94f-c8e6-4e8f-aaa1-2503fbfe575e","_postman_id":"a055c94f-c8e6-4e8f-aaa1-2503fbfe575e","description":""}],"id":"11190cea-de4c-41af-8eeb-39ef04912e92","description":"A API SBS foi criada para simplificar e otimizar o envio de documentos de lançamentos contábeis para o sistema Único da SCI, oferecendo uma solução eficiente e segura para o upload desses arquivos no Amazon S3.
\nEssa API foi desenvolvida e é gerenciada pela SCI, porém a integração com ela é de responsabilidade dos clientes ou parceiros comerciais, que têm interesse em implementá-la conforme suas necessidades.
\n1.Visão Geral
\nA API SBS permite:
\n- \n
- Armazenar documentos de lançamentos contábeis: Faz o upload de documentos diretamente para o Amazon S3 de forma segura. \n
2.Recursos e Benefícios
\n- \n
Escalabilidade: Ideal para empresas de todos os portes, com a capacidade de crescer conforme suas necessidades aumentam.
\n \nSegurança: Integrada com a AWS, garantindo que seus documentos sejam armazenados e transferidos de maneira segura.
\n \nFlexibilidade: Pode ser utilizada tanto por escritórios de contabilidade quanto por seus clientes, adaptando-se a diferentes cenários de uso.
\n \n
Como Usar Esta Documentação
\nNesta documentação, você encontrará:
\n- \n
Referências de Endpoints: Descrição detalhada de cada endpoint disponível, incluindo métodos HTTP, parâmetros necessários, e exemplos de respostas.
\n \nExemplos de Uso: Códigos de exemplo para facilitar a implementação .
\n \nGuia de Autenticação: Instruções para configurar e utilizar tokens de autenticação para acessar a API.
\n \n
URLs Base
\n- \n
- Ambiente de Produção:
URL Base:https://api-sbs.sci.com.br\n
Autenticação
\nPara acessar os endpoints da API SBS, todas as solicitações devem ser autenticadas com um Token de Acesso do tipo Bearer, obtido por meio do SCI WEB, e incluído no cabeçalho da requisição para garantir a autenticação correta.
\nEste Token de Acesso pode ser de dois tipos: \"contabilidade\" (gerado pelo acesso admin do SCI WEB por usuários dos tipos Diretor e TI) ou \"empresa\" (gerado pelo acesso do cliente do SCI WEB). Um token de contabilidade permite que sejam enviados lançamentos contábeis para todas as empresas da contabilidade vinculadas ao token. Enquanto um token de empresa permite que sejam enviados documentos apenas para a empresa que gerou o token.
\nAlém disso, também será necessário um Token de Parceiro que deve ser solicitado atráves do site https://sci.com.br/sistemas-de-gestao/ com as seguintes informações:
\n- \n
Nome da empresa
\n \nCNPJ da empresa
\n \nMunicípio e estado
\n \nCódigo de cliente SCI (informe se não for cliente)
\n \nRegião de atuação
\n \n
Estrutura dos Endpoints
\nOs endpoints possuem uma estrutura base construída conforme o padrão:
\n{urlBase}/api/{versaoApi}/lancamentos-contabeis
Versões de api disponíveis
\n- \n
v1\n
Tipos de Documentos
\nO arquivo enviado precisa estar com o nome conforme o padrão da SCI, sendo composto por:
\n- \n
CL => Tipo (Lançamentos Contábeis) CNPJ da empresa, obrigatóriamente igual ao enviado no documento
\n \nData de exportação em formato YmdHis (Ano, mês, dia, horas, minutos, segundos).
\n \nArquivo em formato txt.
\n \n
Exemplo: CL8257635300010720201223090700.txt
\n3.Layout do Arquivo TXT
\nPara que os arquivos TXT sejam processados corretamente pela API, eles devem seguir o layout padrão estabelecido pela SCI. Qualquer desvio desse formato resultará na rejeição do arquivo. Para obter mais informações sobre a padronização dos arquivos de lançamentos contábeis, consulte o documento complementar Layout SCI.
\n","_postman_id":"11190cea-de4c-41af-8eeb-39ef04912e92"},{"name":"API SCI Report 24h","item":[],"id":"721bc6e1-abca-43c2-89f0-b4d98e6ff97a","description":"O SCI Report 24h é uma solução 100% web que transforma a entrega de documentos contábeis em um serviço digital, ágil e contínuo. Integrado aos sistemas da SCI, ele permite que clientes acessem relatórios e guias diretamente pela internet, com segurança e disponibilidade total — 24 horas por dia, 7 dias por semana. Além disso, oferece recursos como envio automático, visualização de comprovantes, notificações (incluindo WhatsApp) e geração de segunda via, promovendo eficiência e redução de custos para escritórios contábeis.
\nDocumentação oficial da API:
\n\n","_postman_id":"721bc6e1-abca-43c2-89f0-b4d98e6ff97a"}]}