Pereiti prie pagrindinio turinio
Nauja Išbandyti AI PDF Chat nemokamai
Tikrinti metaduomenis Suspausti PDF PDF programinė įranga

API dokumentacija

Integruokite PDF analizę į savo programas naudodami mūsų REST API

Greita pradžia

1

Sukurkite paskyrą

Užsiregistruokite nemokamoje PDFCheck paskyroje, kad pradėtumėte.

2

Sugeneruokite API žetoną

Eikite į API žetonai ir sukurkite naują žetoną.

3

Atlikite pirmą užklausą

Naudokite savo žetoną API užklausų autentifikavimui.

Autentifikacija

Visoms API užklausoms reikalinga autentifikacija naudojant Bearer žetoną Authorization antraštėje.

Authorization: Bearer YOUR_API_TOKEN

Bazinis URL

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

Užklausų limitai

Nemokamos paskyros ribojamos iki 50 PDF analizių per dieną. Likusių patikrinimų skaičius įtraukiamas į kiekvieną API atsakymą.

Galutiniai taškai

GET /user

Gaukite informaciją apie autentifikuotą vartotoją, įskaitant dienos naudojimo limitus.

Atsakymo pavyzdys

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

Įkelkite ir analizuokite PDF failą. Grąžina išsamius iš PDF ištrauktus metaduomenis.

Užklausos turinys

Pavadinimas Tipas Privalomas Aprašymas
file file Privalomas PDF failas analizei (maks. 100 MB)

Užklausos pavyzdys

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

Atsakymo pavyzdys

{
  "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

Peržiūrėkite visas autentifikuoto vartotojo PDF analizes su puslapiavimu.

Užklausos parametrai

Pavadinimas Tipas Numatytoji reikšmė Aprašymas
per_page integer 20 Rezultatų skaičius puslapyje (1–100)

Atsakymo pavyzdys

{
  "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}

Gaukite išsamius analizės rezultatus pagal analizės ID (bendrinimo žetoną).

Užklausos pavyzdys

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

Žetonų valdymas

GET /tokens

Peržiūrėkite visus autentifikuoto vartotojo API žetonus.

POST /tokens

Sukurkite naują API žetoną. Žetonas rodomas tik vieną kartą atsakyme.

Užklausos turinys

Pavadinimas Tipas Privalomas Aprašymas
name string Privalomas Aprašomasis žetono pavadinimas
DELETE /tokens/{id}

Atšaukite (ištrinkite) API žetoną visam laikui.

Klaidų kodai

HTTP kodas Klaidos kodas Aprašymas
401 unauthenticated Neteisingas arba trūkstamas API žetonas
404 not_found Išteklius nerastas arba prieiga uždrausta
422 analysis_failed PDF nepavyko apdoroti (neteisingas arba pažeistas failas)
429 daily_limit_exceeded Dienos limitas viršytas, bandykite rytoj

Kodo pavyzdžiai

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');

Pasiruošę pradėti?

Sukurkite nemokamą paskyrą ir sugeneruokite pirmą API žetoną, kad pradėtumėte integraciją.

Sukurti nemokamą paskyrą Prisijungti