Factum Parse API

API ID 13523

A API Factum Parse se especializa na extração de dados de documentos administrativos e financeiros italianos, incluindo formatos XML e PDF de FatturaPA. Ela garante completa privacidade dos dados com sua política de Retenção Zero de Dados Estrita (ZDR), utilizando RAM volátil e mantendo total conformidade com as regulamentações do GDPR

Documentação da API

Endpoints

Requisição
Carregue uma fatura italiana FatturaPA em XML ou PDF para iniciar a análise do documento
Endpoint ID: 30046
POST https://zylalabs.com/api/13523/factum+parse+api/30046/upload+document
PARÂMETROS DE ENTRADA

Carregar Documento — Recursos do endpoint

Objeto Descrição
Corpo da requisição Obrigatório Json

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

RESPOSTA DE EXEMPLO DA API
JSON
{
    "job_id": "3f2b5e6a-0000-4000-8000-000000000004",
    "doc_type": "fattura_pa_xml",
    "content_hash": "a1b2c3d4e5f67890",
    "size_bytes": 2841,
    "mime_type": "text/xml",
    "deduplicated": false,
    "status": "done"
}
Carregar Documento — TRECHOS DE CÓDIGO

curl --location --request POST 'https://zylalabs.com/api/13523/factum+parse+api/30046/upload+document' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{}'

    
Requisição
Extrair dados JSON estruturados de um ID de trabalho previamente carregado ou texto de entrada bruto
Endpoint ID: 30047
POST https://zylalabs.com/api/13523/factum+parse+api/30047/parse+document
PARÂMETROS DE ENTRADA

Analisar Documento — Recursos do endpoint

Objeto Descrição
Corpo da requisição Obrigatório Json

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

RESPOSTA DE EXEMPLO DA API
JSON
{
    "job_id": "3f2b5e6a-0000-4000-8000-000000000004",
    "status": "done",
    "document_type": "fattura",
    "provider_used": "fast-path-xml",
    "prompt_version": "fattura-v1",
    "confidence": 1,
    "cost_usd": 0,
    "tokens": 0,
    "fallbacks": [],
    "content_hash": "a1b2c3d4e5f67890",
    "result": {
        "supplier": {
            "name": "Company SRL",
            "vat_id": "IT01234567890"
        },
        "totals": {
            "net_amount": 100,
            "vat_amount": 22,
            "total_amount": 122
        }
    }
}
Analisar Documento — TRECHOS DE CÓDIGO

curl --location --request POST 'https://zylalabs.com/api/13523/factum+parse+api/30047/parse+document' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
  "job_id": "3f2b5e6a-0000-4000-8000-000000000004",
  "doc_type": "auto"
}'

    
Requisição
Verifique o status de processamento e os metadados para um trabalho de upload específico
Endpoint ID: 30048
GET https://zylalabs.com/api/13523/factum+parse+api/30048/get+upload+status
PARÂMETROS DE ENTRADA

Solicitações gratuitas de teste restantes: 3 de 3.

Este endpoint não requer parâmetros de entrada.

RESPOSTA DE EXEMPLO DA API
JSON
{
    "job_id": "3f2b5e6a-0000-4000-8000-000000000004",
    "doc_type": "fattura_pa_xml",
    "content_hash": "a1b2c3d4e5f67890",
    "size_bytes": 2841,
    "mime_type": "text/xml",
    "deduplicated": false,
    "status": "done"
}
Obter Status de Upload — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/13523/factum+parse+api/30048/get+upload+status' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Requisição
Ponto de verificação de saúde pública para monitorar o tempo de atividade do sistema
Endpoint ID: 30049
GET https://zylalabs.com/api/13523/factum+parse+api/30049/service+status
PARÂMETROS DE ENTRADA

Solicitações gratuitas de teste restantes: 3 de 3.

Este endpoint não requer parâmetros de entrada.

RESPOSTA DE EXEMPLO DA API
JSON
{
    "status": "ok",
    "service": "factum-parse",
    "version": "0.1.0",
    "environment": "dev",
    "uptime_seconds": 0,
    "data": {
        "total_jobs": 30,
        "done_jobs": 18,
        "failed_jobs": 3,
        "pending_jobs": 9,
        "last_parse_at": "2026-08-13T10:27:42.876838+00:00",
        "cost_per_doc_usd": 0.00021
    }
}
Status do Serviço — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/13523/factum+parse+api/30049/service+status' --header 'Authorization: Bearer YOUR_API_KEY' 


    

Chave de acesso à API e autenticação

Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Factum Parse API basta incluir seu token Bearer no cabeçalho Authorization.

Cabeçalhos
Cabeçalho Descrição
Authorization Obrigatório Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.

Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.

(Economize 2 meses com cobrança anual 🎉)

🚀 Plano Empresarial

A partir de
$ 10.000/Ano


  • Volume personalizado
  • Limite de taxa personalizado
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real

Visão Geral

A API Factum Parse é especializada na extração de dados de documentos administrativos e financeiros italianos, incluindo formatos XML e PDF FatturaPA. Garante a completa privacidade dos dados com sua política de Reter Dados Zero Estrita (ZDR), utilizando RAM volátil e mantendo total conformidade com as regulamentações do GDPR

Factum Parse API FAQs

O endpoint "Carregar Documento" retorna metadados sobre o documento carregado, incluindo ID do trabalho e status O endpoint "Analisar Documento" retorna dados JSON estruturados extraídos do documento, como detalhes do fornecedor e totais O endpoint "Obter Status do Carregamento" fornece o status e metadados do carregamento, enquanto o endpoint "Status do Serviço" oferece informações sobre a saúde do sistema, incluindo estatísticas do trabalho

Os campos principais incluem "job_id" (identificador único) "status" (estado de processamento) "document_type" (tipo de documento) "result" (dados analisados) e "content_hash" (hash do conteúdo do documento) Para o status do serviço campos como "total_jobs" e "done_jobs" fornecem insights sobre o desempenho do sistema

Os dados retornados estão estruturados no formato JSON Cada resposta contém pares de chave-valor organizados em objetos aninhados como "resultado" para dados analisados e "dados" para estatísticas de serviço Essa estrutura permite o acesso fácil a informações específicas como detalhes do fornecedor ou status do trabalho

O endpoint "Carregar Documento" fornece metadados de upload O endpoint "Analisar Documento" extrai dados detalhados de fatura incluindo informações do fornecedor e totais financeiros O endpoint "Obter Status de Upload" oferece status de processamento enquanto o endpoint "Status do Serviço" fornece uma visão geral da saúde do sistema e estatísticas de trabalho

Os dados de resposta são organizados em seções distintas com base no ponto de extremidade Por exemplo a resposta "Parse Document" inclui "job_id" "status" e um objeto "result" contendo detalhes da fatura analisada Essa organização ajuda os usuários a localizar rapidamente informações relevantes

Os dados são obtidos de faturas XML e PDF do FatturaPA italiano, garantindo conformidade com as estruturas administrativas italianas A API emprega uma arquitetura de Zero-Retention com foco na Privacidade, o que significa que nenhum dado é armazenado, aumentando a segurança e a privacidade dos dados

Casos de uso típicos incluem automação do processamento de faturas extração de dados financeiros para contabilidade e integração das informações de faturas em sistemas empresariais Os usuários podem aproveitar a saída JSON estruturada para relatórios e análises

Os usuários podem analisar o JSON estruturado para extrair campos específicos, como nomes de fornecedores ou valores totais, para processamento adicional. Esses dados podem ser integrados a sistemas financeiros ou utilizados para relatórios de conformidade, aumentando a eficiência operacional

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.
Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]

Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.
A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.
Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]
Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.
As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.
O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.
Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.
Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.
Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.
O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.
Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.
Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.
Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.
Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.
As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.
Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]

APIs relacionadas


Você também pode gostar