Overview

The Asis API is the way to process, audit and extract results from SPED files, audits and related products and services of the Kolossus solution. It is a lower level HTTP-based API than Sped Web Auditor to programmatically send and retrieve data enabling integration between systems and applications.

Basic notions

• Application is what identifies who is executing API calls.
• Account is the entity that groups all other entities below it, for example, Processes, Files, Results. It is used to segregate and isolate customers / establishments / organizations.
• Process is when we receive a file and/or other trigger and we will process audits and/or other events on the system. Processing analyzes and processes data from the perspective of the file and/or the database of an account. Every process has asynchronous execution, has state and generates results when there are returns on the requested context
• Result is the return of data representing audits, crossings, reports and so on. The result is presented in two ways:
  • Synthetic : Lists all the results of a process, such as the results of audits in a file, for example, the NCM's validation. The synthetic result shows result information such as the audit name, its legal basis, the diagnosis (Error, Warning, Benefit or Report), quantity of results and other more information.
  • Analytical : is the items of a Result, such as the data that audits or events processed, for example, each invalid NCM item of 0200 record of EFD/PIS AND COFINS

HTTP

The Asis API is based on HTTP, so it works with any language that has an HTTP library. This means that you can also use tools that implement an HTTP library, like cURL, urllib and Postman, for example:

URL

In the Kolossus solution, we have 3 APIs to receive requests and access its resources.

• Upload Web API (https://file.asisprojetos.com.br/api) responsible for receiving the files
• Core Web API (https://corewebapi.asisprojetos.com.br/api)responsible for accessing API entities
• Resultado Web API (https://resultadowebapi.asisprojetos.com.br/api) responsible for accessing processed file and event returns

Version

To use the version just add the letter v followed by the version number at the beginning of the request path right after the literal "/api". For example, this is a call to version 1:

Next steps

Now let's see the session Get Started to know some of the most requested calls and their respective responses, as well as other actions you can take with the Asis API.