Vai al contenuto principale

Documentazione API

Integra l'analisi PDF nelle tue applicazioni con la nostra REST API

Guida Rapida

1

Crea un Account

Registrati per un account PDFCheck gratuito per iniziare.

2

Genera un Token API

Vai su Token API e crea un nuovo token.

3

Effettua la Tua Prima Richiesta

Usa il tuo token per autenticare le richieste API.

Autenticazione

Tutte le richieste API richiedono l'autenticazione tramite un token Bearer nell'header Authorization.

Authorization: Bearer YOUR_API_TOKEN

URL Base

https://pdf.businesspress.io/api/v1

Limiti di Frequenza

Gli account gratuiti sono limitati a 50 analisi PDF al giorno. I controlli rimanenti sono inclusi in ogni risposta API.

Endpoint

GET /user

Ottieni informazioni sull'utente autenticato inclusi i limiti di utilizzo giornalieri.

Esempio di Risposta

{
  "success": true,
  "data": {
    "name": "John Doe",
    "email": "john@example.com",
    "daily_limit": 50,
    "remaining_checks": 47,
    "checks_used_today": 3
  }
}
POST /pdf/analyze

Carica e analizza un file PDF. Restituisce i metadati dettagliati estratti dal PDF.

Corpo della Richiesta

Nome Tipo Obbligatorio Descrizione
file file Obbligatorio File PDF da analizzare (max 100MB)

Esempio di Richiesta

curl -X POST https://pdf.businesspress.io/api/v1/pdf/analyze \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@document.pdf"

Esempio di Risposta

{
  "success": true,
  "data": {
    "id": "abc123xyz789",
    "filename": "document.pdf",
    "file_size": 1048576,
    "file_size_formatted": "1.00 MB",
    "metadata": {
      "title": "My Document",
      "author": "John Doe",
      "creator": "Microsoft Word",
      "producer": "Adobe PDF Library",
      "page_count": 10,
      "pdf_version": "1.7",
      "dates": {
        "created": "2025-01-15T10:30:00Z",
        "modified": "2025-01-16T14:22:00Z",
        "was_modified": true
      }
    },
    "analyzed_at": "2025-01-17T18:00:00Z"
  },
  "remaining_checks": 46
}
GET /pdf

Elenca tutte le analisi PDF per l'utente autenticato con paginazione.

Parametri di Query

Nome Tipo Predefinito Descrizione
per_page integer 20 Numero di risultati per pagina (1-100)

Esempio di Risposta

{
  "success": true,
  "data": [
    {
      "id": "abc123xyz789",
      "filename": "document.pdf",
      "file_size": 1048576,
      "file_size_formatted": "1.00 MB",
      "analyzed_at": "2025-01-17T18:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 20,
    "total": 1
  }
}
GET /pdf/{id}

Ottieni i risultati dettagliati dell'analisi tramite l'ID dell'analisi (token di condivisione).

Esempio di Richiesta

curl https://pdf.businesspress.io/api/v1/pdf/abc123xyz789 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Gestione Token

GET /tokens

Elenca tutti i token API per l'utente autenticato.

POST /tokens

Crea un nuovo token API. Il token viene mostrato solo una volta nella risposta.

Corpo della Richiesta

Nome Tipo Obbligatorio Descrizione
name string Obbligatorio Un nome descrittivo per il token
DELETE /tokens/{id}

Revoca (elimina) un token API in modo permanente.

Codici di Errore

Codice HTTP Codice Errore Descrizione
401 unauthenticated Token API non valido o mancante
404 not_found Risorsa non trovata o accesso negato
422 analysis_failed Il PDF non ha potuto essere elaborato (file non valido o corrotto)
429 daily_limit_exceeded Limite giornaliero superato, riprova domani

Esempi di Codice

cURL

# Analyze a PDF
curl -X POST https://pdf.businesspress.io/api/v1/pdf/analyze \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@/path/to/document.pdf"

# Get analysis result
curl https://pdf.businesspress.io/api/v1/pdf/abc123xyz789 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

# List all analyses
curl https://pdf.businesspress.io/api/v1/pdf \
  -H "Authorization: Bearer YOUR_API_TOKEN"

PHP

<?php
$apiToken = 'YOUR_API_TOKEN';
$filePath = '/path/to/document.pdf';

// Analyze PDF
$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => 'https://pdf.businesspress.io/api/v1/pdf/analyze',
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiToken,
    ],
    CURLOPT_POSTFIELDS => [
        'file' => new CURLFile($filePath, 'application/pdf'),
    ],
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

if ($result['success']) {
    echo "Analysis ID: " . $result['data']['id'] . "\n";
    echo "Pages: " . $result['data']['metadata']['page_count'] . "\n";
    echo "Remaining checks: " . $result['remaining_checks'] . "\n";
}

curl_close($ch);

Python

import requests

API_TOKEN = 'YOUR_API_TOKEN'
BASE_URL = 'https://pdf.businesspress.io/api/v1'

headers = {
    'Authorization': f'Bearer {API_TOKEN}'
}

# Analyze PDF
with open('/path/to/document.pdf', 'rb') as f:
    response = requests.post(
        f'{BASE_URL}/pdf/analyze',
        headers=headers,
        files={'file': ('document.pdf', f, 'application/pdf')}
    )

result = response.json()

if result['success']:
    print(f"Analysis ID: {result['data']['id']}")
    print(f"Pages: {result['data']['metadata']['page_count']}")
    print(f"Remaining checks: {result['remaining_checks']}")

# Get analysis by ID
response = requests.get(
    f"{BASE_URL}/pdf/{result['data']['id']}",
    headers=headers
)
print(response.json())

JavaScript (Node.js)

const fs = require('fs');
const FormData = require('form-data');

const API_TOKEN = 'YOUR_API_TOKEN';
const BASE_URL = 'https://pdf.businesspress.io/api/v1';

async function analyzePdf(filePath) {
    const form = new FormData();
    form.append('file', fs.createReadStream(filePath));

    const response = await fetch(`${BASE_URL}/pdf/analyze`, {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${API_TOKEN}`,
        },
        body: form
    });

    const result = await response.json();
    
    if (result.success) {
        console.log(`Analysis ID: ${result.data.id}`);
        console.log(`Pages: ${result.data.metadata.page_count}`);
        console.log(`Remaining checks: ${result.remaining_checks}`);
    }
    
    return result;
}

// Usage
analyzePdf('/path/to/document.pdf');

Pronto per Iniziare?

Crea un account gratuito e genera il tuo primo token API per iniziare l'integrazione.