Converse com nosso time pelo chat.

Recomendamos aplicar as seguintes medidas para maior segurança do token:

Seguimos o mesmo modelo do Twilio e da Amazon.

Geramos um token de autenticação que deve ser informado em todas as chamadas. Este token é um segredo e deve ser tratado exatamente como uma senha.

Só são possíveis chamadas via SSL (TLS 1.2).

Opcionalmente, podemos configurar a autenticação por certificado digital, mas isto exige um endpoint dedicado ao cliente.

Para qualquer API, caso queira o output em json ou xml, basta incluir ao final &format=json (ou xml)

As APIs também funcionam de forma assíncrona, basta informar no final da URL os parâmetros: &options={async:true, async_run_persistent:true} e depois utilizar o UID retornado para obter o resultado da chamada.

Parâmetro async: Indica se deve executar a transação de forma assíncrona (false por padrão).

Valores:

Exemplo de uso: &options={async:true}

Exemplo com Sintegra Unificada:

Para os relatórios, é recomendado usar a chamada no modelo assíncrono, desta forma, a primeira chamada (https://api.exato.digital/exec-datasource?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&consulta_tipo_id=5025&parametros=12387530000113&options={async:true}) vai retornar um identificador único (UID) que deve ser passado como parâmetro no segundo endpoint: https://api.exato.digital/exec-datasource?token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&consulta_tipo_id=5025&uid=[UID]

O segundo endpoint vai retornar código 12 (em execução) enquanto a consulta estiver sendo processada. Ao ser finalizada, este código deve mudar para 1 (sucesso) ou alguma outra situação.

exec_mode: Modo de execução da consulta. (por padrão o modo é normal).

Tipo aceito: número inteiro

Valores:

Exemplo: &options={exec_mode:1}

async: Indica se deve executar a transação de forma assíncrona (false por padrão).

Tipo aceito: booleano

Valores:

Exemplo: &options={async:true}

async_run_persistent: Indica se deve executar uma transação assíncrona até obter um resultado final (false por padrão).

Tipo aceito: booleano

Valores:

Exemplo: &options={async_run_persistent:true}

cache_limit_in_hours: Limite, em horas, que uma consulta é aceita do cache. Caso informado, o sistema tenta buscar a consulta com a mesma chave de entrada no cache interno, retornando os dados caso encontre no período informado. Atenção: Quando a consulta é lida do cache, a velocidade é bem superior a online pois vem direto da base de dados, porém, o dado não será online, e sim da data encontrada no cache. (null por padrão).

Tipo aceito: número inteiro

Valores:

Exemplo: &options={cache_limit_in_hours:1}

cache_include_not_found: Indica se deve incluir resultados "Entidade não encontrada" na busca em cache (null por padrão).

Tipo aceito: booleano

Valores:

Exemplo: &options={cache_include_not_found:true}

generate_result_pdf: Indica que se a fonte de dados possuir comprovante em PDF, ele deve ser obrigatoriamente retornado. Caso esta opção seja especificada como 'enable' e haja falha na geração do comprovante em PDF, a consulta apresentará erros. (null por padrão).

Tipo aceito: número inteiro

Valores:

Exemplo: &options={generate_result_pdf:true}

generate_pdf_sync: Indica se deve gerar o PDF de forma síncrona (false por padrão).

Tipo aceito: booleano

Valores:

Exemplo: &options={generate_pdf_sync:true}

allow_outdated_result: Indica se deve aceitar resultado desatualizado para alguns tipos de retorno, caso não seja possível realizar a consulta on-line ou do cache. (null por padrão)

Tipo aceito: número inteiro

Valores:

Exemplo: &options={allow_outdated_result:1}

timeout_ms: Indica o timeout da transação. O valor especificado pode ou não ser respeitado de acordo com os termos do contrato com o cliente (null por padrão).

Tipo aceito: número inteiro (em milisegundos)

Exemplo: &options={timeout_ms:60000}

read_from_cache: Indica que a chamada aceita leitura de resultados do cache (se existir). Por padrão, a consulta é executada usando o cache diário, ou seja, se a mesma consulta para a mesma entrada foi efetuada no mesmo dia com sucesso anteriormente, o resultado retornado será oriundo do cache.

Tipo aceito: número inteiro

Valores:

Exemplo: &options={read_from_cache:10}

outdated_result_limit_in_hours: Tempo (em horas) que o sistema deve buscar a consulta no cache em caso de aceite de resultados antigos (datados). Este parâmetro só funciona caso o parâmetro 'allow_outdated_result' seja passado como enable.

Tipo aceito: número inteiro (valor em horas)

Exemplo: &options={outdated_result_limit_in_hours:10}

custom_parameters: Parâmetros customizados específicos para seu token de acesso.

Tipo aceito: string

Exemplo: &options={custom_parameters:’parametro_teste:1’}

callback_url: URL de callback de resultado da chamada (webhook). Ao ser informado, o resultado da consulta será postado (POST) para a URL informada.

Tipo aceito: string

Exemplo: &options={callback_url:url_de_callback}

result_html: Indica que deve retornar o bloco de informações em formato html. Utilizado para exibição do resultado da consulta direto em tela. (campo ResultHtml) (false por padrão).

Tipo aceito: boolean

Valores:

Exemplo: &options={result_html:true}

Como automatizamos consultas diretamente das fontes oficiais de dados, algumas chamadas podem demorar algum tempo para retornar ou até mesmo passarem por períodos de indisponibilidade. Caso ocorra lentidão, aguarde alguns minutos e tente executar novamente. Caso o erro persista, entre em contato com o [email protected]