API de Extração de Dados

Nossa API de Extração de Dados é a ferramenta que transforma seus documentos e imagens em informações valiosas! Ela usa os layouts personalizados que você criou para identificar e extrair os dados que você precisa. Vamos explorar como usar a API para realizar essa mágica.

Informação

Para começar a usar qualquer uma de nossas APIs, você precisará de uma chave de API válida. Se você ainda não tem uma, clique aqui para aprender como obter a sua. Guarde sua chave em um lugar seguro, pois ela será sua credencial para todas as requisições à API.

Informação

Lembre-se: antes de extrair dados, você precisa criar um layout que defina quais informações serão extraídas. Se você ainda não fez isso, siga nosso tutorial de configuração de layout clicando aqui.

Chamando a API de Extração: O Passo a Passo

Com seu layout configurado, o próximo passo é obter o layout_id. Você encontra esse ID na página de gerenciamento de layouts – ele é como o número de identificação do seu layout. Esse layout_id informa à API quais campos devem ser extraídos do documento.

Agora, vamos realizar a requisição à API. Você pode usar o seguinte comando curl como exemplo:

Loading code example...

Entendendo os Parâmetros:

• 'https://api.tech4.ai/document/extract/': A URL da API de Extração de Dados.
• 'x-client-key: Aqui você insere sua chave de API para autenticar sua requisição.
• file_url: A URL do arquivo (imagem ou documento) que você deseja analisar. Certifique-se de que a URL seja acessível pela API.
• layout_id: O ID do layout que você criou para extrair os dados do documento.

Códigos de Retorno e Respostas

A API responderá com um código de status e, em alguns casos, com dados no formato JSON. Aqui está um guia dos possíveis retornos:

• 200 - Ok, Partial, Error:

  • Significado: Extração realizada com sucesso!
  • Exemplo de Retorno:

  {
    "status": "ok",
    "extracted_data": {
      "categoria_habilitacao": "AB",
      "data_validade": "2034-07-11",
      "data_1a_habilitacao": "2004-03-26"
    }
  }

  • status: Indica o status da requisição, podendo ser "ok" para quando todos os campos foram extraídos com sucesso, "partial" para quando alguns campos não foram extraídos e "error" para quando não foi possível extrair nenhum campo.
  • extracted_data: Um objeto JSON contendo os dados extraídos, de acordo com o layout que você definiu.

• 400 - Bad Request:

  • Significado: A requisição está mal formada. Geralmente, isso acontece quando a URL do arquivo não é válida.
  • Exemplo de Retorno:

  {
    "detail": "Failed to get file content: HTTP error occurred: 400 - 400 Client Error: Value for one of the query parameters specified in the request URI is invalid. for url: https://imagem.com/"
  }

  • detail: Fornece uma mensagem detalhada sobre o erro.

• 401 - Unauthorized:

  • Significado: A chave de API (X-API-KEY) é inválida ou não foi fornecida.
  • Exemplo de Retorno:

  {
    "detail": "Invalid client key"
  }

  • detail: Indica que a chave do cliente é inválida.

• 404 - Not Found:

  • Significado: O layout_id fornecido não foi encontrado. Verifique se o ID está correto e se o layout existe.
  • Exemplo de Retorno:

  {
    "detail": "404: Layout not found"
  }

  • detail: Informa que o layout não foi encontrado.

Com este guia, você está pronto para começar a usar a API de Extração de Dados e transformar seus documentos em informações valiosas! Se tiver alguma dúvida, não hesite em nos contatar.