Manual API DOCS

• Introdução
• Autenticação
• Acessos
• DOCS/ Finalizados
• Descrição dos campos da chamada e retorno
• Exemplos de chamada e retorno

Introdução

Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações internas ao nosso módulo Systax DOCS via API.

Com o objetivo de facilitar esse processo de integração, a Systax possui um módulo de integração construído na forma de API, o que garante a interoperabilidade com sistemas desenvolvidos em linguagens e plataformas diversas.

Autenticação

A autenticação na API mencionada nesse documento, é feita via Bearer Token. A obtenção do Token é via autenticação pelo tipo Basic Auth (via usuário e senha, disponibilizados pela Systax). Para mais informações Clique aqui.

URL para obtenção do Token: https://app.systax.com.br/auth/access-token

Acessos

Comunicação: REST/JSON

Swagger Serviços de Captura de XML
https://apidfe.systax.com.br/documentos/swagger/index.html

Listagem do Endpoint que contempla o manual do DOCS.

Descrição	Grupo Swagger	Método	URL Endpoint	URL Token
Docs Finalizados	DOCS	GET	https://apidfe.systax.com.br/documentos/Docs/Finalizados	https://app.systax.com.br/auth/access-token

DOCS/ Finalizados

Descrição dos campos da chamada e retorno

Filtros que poderão ser utilizados na chamada

Campo	Tipo	Formato	Descrição	Observação
dt	string	($date-time)	Data de início	Formato yyyy-MM-dd
tipoDocumento	String		tipoDocumento	Vide tabela Código de descrição dos tipos de documento abaixo
formatarFilePadrao	boolean	lista	Opções: -- True False	Quando vazio e True envia em formato XML e quando False apresenta o binario/base64.
idDocs	String		Id do Documento	Busca específica de documento.
nsuDfe	string		nsuDfe	Campo utilizado para paginar. Informar o último NSU entregue na pagina anterior.
IdCliente	integer	($int64)	IdCliente	Busca por cliente.

Código e descrição dos tipos de documento

Campo	Descrição
0 - Original	Documento original da Nota de Serviço. Podendo ser um PDF, um XML ou até mesmo um JPEG
1 - Email	Texto que veio no e-mail junto com a nota de serviço. Guardamos o texto do e-mail, pois em alguns casos, algumas informações da nota de serviço vêm direto no corpo do e-mail.
2 - Extraído	Informações em um XML, que foram extraídas do arquivo recebido, através de um processo automático que temos
3 - Padrão	Seria o arquivo final, o mesmo que estávamos enviando na versão anterior do WS. Esse arquivo pode sofrer alterações com o tempo, através de processos manuais feitos dentro do DFe.  Sempre que o arquivo é alterado, ele é adicionado novamente na fila com um novo NSU, para que vocês recebam sempre a última versão do arquivo.

Tabela de referência para o campo "success" e "message"

Código de retorno	sucess	message	Observação
200	True	Ok
400	False	Bad Request	Parâmetros
			da solicitação incorretos.
404	False	Not Found	Não foram
			encontrados registros

Descrição dos campos de retorno:

Campo	Tipo	Descrição
nsu	integer($int64)	NSU doDOCs
Id_docs	integer($int64)	ID Systax do Documento
statusDocs	string	Código do status do documento
statusDescricao	string	Descrição do status do documento
file	string($byte)	Documento requisitado
fileNome	string	Nome do Documento + extensão
fileTipo	string	Tipo do Documento
filePadrao	string	Documento padrão
observacao	string	Descrição do Documento

O Campo "observacao" do retorno da chamada, foram mapeados com as seguintes descrições:

Descrição/Mensagem	Status
XML Padrão Completo	Quando status for 800 - Concluído
Documento descartado	Quando o status for 900 - Descartado
XML Padrão em Desenvolvimento	XML Padrão em Desenvolvimento - Para todos os outros status

Tabela de código de status de retorno (campos "código" e "mensagem")

Código	Mensagem
10	Recebido
15	Chamada incompleta
16	Usuário e/ou senha inválidos
17	Captura direta de PDF
20	Pendente de captura
25	Identificando tipo de documento
28	Classificando documento
30	Conteúdo original disponível
31	O Arquivo não foi obtido no S3 ou no disco
35	Arquivos na fila do OCR
40	Convertido
42	Fila OCR Posicional
45	Retorno OCR Posicional
50	Pendente de identificação do padrão
100	Tratamento Upload
120	Aguardando melhoria de imagem
150	Digitar
155	Averiguar
156	Averiguar - Anexos Iguais
160	Extraindo Fornecedor
170	Fornecedor Extraído
180	Aguardando XML
200	Dados extraídos
250	Dados extraídos - outros documentos
300	Documento gerado no layout padrão
400	Documento gerado no layout do usuário
404	Erro processamento OCR
500	Fluxo para revisão de cancelamentos
700	Definindo município incidência
750	Revisar
790	Triagem
800	Concluído
810	Concluído com NF cancelada
850	Integrado a gestão do usuário
900	Descartado
910	Excesso de Páginas
920	Duplicado
930	Desacordo
940	Sobrescrito
950	Documentos Iguais
960	Registro Vazio

Obs.: Em relação ao retorno do status, nós entregamos o 800 e qualquer outro, abaixo de 800, se ficar parado por mais de 24 horas no processamento, exceto: Descartado 900 e 920.

Exemplos de chamada e retorno

Chamada utilizando o filtro idDocs

https://apidfe.systax.com.br/documentos/Docs/Finalizados?idDocs=32799734

Retorno

{
    "docs": [
        {
            "nsu": 23342212,
            "idDocs": 32799734,
            "statusDocs": "800",
            "statusDescricao": "800 - Concluído",
            "file": "JVBERi0xLjQKJdP0zOEKMSAwIG9iago8PAovQ3JlYXRpb25EYXRlKEQ6MjAyNDAxMDIxNDAwMjYtMDMnMDAnKQovQ3JlYXR/4B7HBAKGSghihZ0XMRJgDM4EMtIGP8YgsdGtRyum2gemu7SAnHjbEqnT4R+uCcQ7xJcCTxiFVep06p1uZZYlVyumEaMg/N5OqSRYvZ9516gmHnnrpGU/GiT5gBChNT2aVIoWP5SjiBHpdQBh4AmAdvNqCP1QBHi1bOcfOKUOK6aAvQC0/GiEO6SFcIjb3Hh0cN2pYfBwsrjp+3K3AL5yuOnn6rZzgxAsig16S5GNx/cA+Rj6TxTSZZSRpTTJcBF4stqia5WIhBB4OLymAzqP6bQkzmGRaXvzioSa7DbrpON618KEblJhzIbV2EFyadiqSKWzUoDBLo4/Nmup8uNnehHPsr54VZBefqznG536+hPnhEC9/To60o5ash+YSdU0GMDRdcmq2EfzwVPs4kqH7Sb0KpiUHmbzNwOCOSN4o0DxXS+5sStEgngVPCDDcFPjLfD6YeNo5/74ffLFLAlj5GTbVrcpCW2q8s2v6MSTQSOQ33nklQIVhxEVrIWeIM+GNd2k0Xk9tIENA9+a9pNmQv1Nlpu19GDd0Eh0isz4zFaz+wcNZ6+cs0Jz+vTwxRSbRsvM00sY9K+S9lED9CELd9PPRjbHfBawcAhq2S5mX4fL/YbraihhwJwkZgc9lCj8Op+0vkpK2PQynDuS2F5k/64BnGDofBCb5PDv790IgBzBeuxNk8ndKXjw/H4dX2bacmq0vSga48KTa4q+jJrct9Fi8Yc4jbRxQk5NIr227VzH8WaYnN6fsEDys4gXxD3QJGQ4fJFEFemh9Ck2GMJTbAcLmfxPB+nQGmG7tM834tap73LLwiKdWOTYLOKZq49spNAYUyTKQ4Cuko7KaG5PGjc+9Hyh93jabBZbC4m8SqpwvJKL9ka7c9mfAwsr9xX3IHFlm7TzQ6otGzcowv+GD/EDs1STzLEqHoBChAMcnFxYGK3D3iyKrU7tsN1kp+agPygxu+aldWvdD8owjh/kZGvomX05sMsz1DCPKadMFTJ1j+jZBdj7+vpIhtqHuwgPwe3qnaRR79JX0SL+z0EGYNfNe8vw8uYxqq0vwz8InFn68AA0vg3Anoly3m85+/zpMlq+4de4rdWXFS5ienNoTdjRN+H8E+LwWjZ3ygGd/lFGUJYCNuAM+CdIhSzT+Ihkl5YGKSAlgVW0LPssDjlQs4Etx/a0kxElqY1NE50FFRAN29DHsHPAszZevLpPInWQFKiIasOhtDwHVbtKAx0E1RQOmFvQQkHebBjwFqikaULCwt4CFqhSAyogGzNAs6xkgO108yGzngCqKBswPGTq+xIAHnVcYnVk+FUGHuL2MHZe5PrBlNAdpyOGz4JhP6F504vA3YYRXxh7ZA4rG9Tw8SNKD6yeKImw8FBHvP/V0ZZ7ldBuP1kqIDdvEetnZBsQxr03R7G/awh12AAVs3YH1ohwFrm71633fOIXVEkRJl2Y6c6cOBETEkD2X++N0PLf0fSJCQocKsvHx6SDsL4yvF06OliESI1Je9I8HLs8P5Kb8WEcfDayev/uyuG7/2No8raye846uOI5TzTsBYYWN/sLLvyJtfGnvLMum+0qQ/P22Z1P2QCxGfHm7xpQ4vTfnzEX9hWtam8R/5adkYftyCG4fzM3cuPyb1pbcFFAveNRiFhhEoTI8UI0+++tBHvxr674decfzuR0cPHst5Q6vNYwB/5jzjlpG/4+gb4qRj2knbSTsaQKntNxrM4X8hmQWGovOgO+DOldNSX3pV2nLyYC388XuDIqJ/fWd06PiyPaITzXzCWBl+Oto4Kei3SDd8MrrCG5i6MRhslUHdN1nyCIjun7jQvI+JKLiLqKNAC5mIpjGoIcYvGSJ9REs1eBYQTaTXuEa181HhqASpQXgFg3kLJqJKushIixqwMZVrOQgNTU2IDU1NiA1MDAgNTU2IDUwMF0KPj4KZW5kHJlZgoxMDk5MjEKJSVFT0YK",
            "fileNome": "32799734_484908_2_202403071_484908_ch_202216057579_1.pdf",
            "fileTipo": "application/pdf",
            "filePadrao": "xpZGFkZUlTUz5OQU88L0V4aWJpbGlkYWRlSVNTPjxNdW5pY2lwaW9JbmNpZGVuY2lhPjQxMDY5MDI8L011bmljaXBpb0luY2lkZW5jaWE+PE51bWVyb1Byb2Nlc3NvPkNOUEogL0NQRiAvTklGPC9OdW1lcm9Qcm9jZXNzbz48L1NlcnZpY28+PFByZXN0YWRvcj48Q3BmQ25waj48Q3BmPjwvQ3BmPjxDbnBqPjUwOTUxMzE5MDAwMTcwPC9DbnBqPjwvQ3BmQ25waj48SW5zY3JpY2FvTXVuaWNpcGFsPjgxOTQwPC9JbnNjcmljYW9NdW5pY2lwYWw+PC9QcmVzdGFkb3I+PFRvbWFkb3I+PElkZW50aWZpY2FjYW9Ub21hZG9yPjxDcGZDbnBqPjxDcGY+PC9DcGY+PENucGo+NjE4Mzc1NDgwMDEzMTk8L0NucGo+PC9DcGZDbnBqPjxJbnNjcmljYW9NdW5pY2lwYWw+MTA0MDIyMTAwPC9JbnNjcmljYW9NdW5pY2lwYWw+PC9JZGVudGlmaWNhY2FvVG9tYWRvcj48TmlmVG9tYWRvcj48L05pZlRvbWFkb3I+PFJhemFvU29jaWFsPkdVSFJJTkcgQlJBU0lMIEZFUlJBTUVOVEFTIExUREE8L1JhemFvU29jaWFsPjxFbmRlcmVjbz48RW5kZXJlY28+UEVEUk8gWkFHT05FTDwvRW5kZXJlY28+PE51bWVybz40NDE8L051bWVybz48Q29tcGxlbWVudG8+SUdORVogREUgU09VWkEgU09BUkVTLCA1MTwvQ29tcGxlbWVudG8+PEJhaXJybz5QRURSTyBaQUdPTkVMPC9CYWlycm8+PENvZGlnb011bmljaXBpbz40MTA2OTAyPC9Db2RpZ29NdW5pY2lwaW8+PFVmPlBSPC9VZj48Q29kaWdvUGFpcz5OT01FIC8gTk9NRSBFTVBSRVNBUklBTDwvQ29kaWdvUGFpcz48Q2VwPjgxMDUwMTEwPC9DZXA+PC9FbmRlcmVjbz48Q2FTE8gU04gLTwvSW5jZW50aXZvRmlzY2FsPjwvSW5mRGVjbGFyYWNhb1ByZXN0YWNhb1NlcnZpY28+PC9EZWNsYXJhY2FvUHJlc3RhY2FvU2Vydmljbz48L0luZk5mc2U+",
            "observacao": "XML Padrão Completo"
        }
    ]
}