Como funcionam as APIs

Owned by Amanda Vale (Unlicensed)
Last updated: Jul 20, 2020
1 min read

A consulta através de API permite a você receber as mesmas informações que as disponibilizadas nos portais oficiais, com a possibilidade de integrar ao seu processo da forma mais conveniente.

O fluxo de consulta consiste no seguinte:

  1. Você faz uma requisição à API da consulta

    1. Na requisição você pode enviar uma URL de callback se desejar. Essa URL será acionada quando a resposta da consulta estiver pronta.

  2. Ao fazer a requisição, você recebe como resposta o campo requestId, que contém o identificador da requisição.

  3. Quando o resultado estiver pronto,

    1. Caso você tenha informado a URL de callback, receberá o resultado neste endereço.

  4. Você pode consultar o resultado da consulta a qualquer momento, informando o requestId recebido.