Visão Geral

A Asis API é a forma de processar, auditar e extrair resultados de arquivos SPED, auditorias e afins de produto e serviços da solução Kolossus. É uma API baseada em HTTP de nível inferior ao Auditor Sped Web para enviar e obter dados de forma programática possibilitando integração entre sistemas e aplicações.

Noções Básicas

Aplicativo é entidade que define quem está executando chamadas na API.
Conta é a entidade que agrupa todas as outras entidades abaixo dela, ex: Processos, Arquivos, Resultados. È usado para segregar e isolar clientes/estabelecimentos/organização.
Processo é quando recebemos um arquivo e/ou outro gatilho e iremos processar auditorias e/ou outros eventos no sistema. Os processamentos analisam e processam dados sobre a ótica do arquivo e/ou a base de dados de uma conta. Todo processo tem execução assíncrona, possui estado e gera resultados quando há retornos sobre o contexto requisitado
Resultado é retorno de dados que representam auditorias, cruzamentos, relátorios e afins. O resultado é apresentado de duas formas:
- Sintético : Lista todos os resultados de um processo, tais como, os resultados das auditorias sobre um arquivo, por exemplo a validação de NCM's. O resultado sintético mostra informações do resultado como o nome de uma auditoria, sua fundamentação legal, o diagnostico (Erro, Advertência, Benêficio ou Relatório) qtde de resultados e outras mais informações.
- Analítico : é os itens de um Resultado, tais como os dados que as auditorias ou eventos processaram, por exemplo, cada item de NCM inválido do registro 0200 do EFD/PIS E COFINS

HTTP

A Asis API tem base em HTTP, portanto, funciona com qualquer linguagem que tenha uma biblioteca HTTP. Isso quer dizer que você também pode usar ferramentas que implementam uma bliblioteca HTTP, como cURL, urllib e o Postman por exemplo:


            curl -X GET \ 

            https://corewebapi.asisprojetos.com.br/api/v1/processo \ 

            -H 'account-key: 6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875' \ 

            -H 'app-key: 4e07408562bedb8b60ce05c1decfe3ad16b72230967de01f640b7e4729b49'

URL

Na solução Kolossus, temos 3 API's para receber solicitações e acessar seus recursos.

Upload Web API (https://file.asisprojetos.com.br/api) responsável por receber os arquivos
Core Web API (https://corewebapi.asisprojetos.com.br/api) responsável por acessar as entidades da API
Resultado Web API (https://resultadowebapi.asisprojetos.com.br/api) responsável por acessar retornos de arquivos e eventos procesados

Versão

Para utilizar a versão basta adicionar a letra v seguida do número da versão ao início do caminho da solicitação logo após o literal "/api". Por exemplo, esta é uma chamada para a versão 1:


                curl -X GET \ 

                https://corewebapi.asisprojetos.com.br/api/v1/processo/23987 \ 

                -H 'account-key: 6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875' \ 

                -H 'app-key: 4e07408562bedb8b60ce05c1decfe3ad16b72230967de01f640b7e4729b49'

Próximas etapas

Agora, vamos analisar a sessão Como Iniciar para ver algumas solicitações mais requisitadas e suas respectivas respostas, além de outras ações que você pode realizar com a Asis API.