Spring til hovedindhold

API-dokumentation

Integrer PDF-analyse i dine applikationer med vores REST API

Administrer API-tokens

Din første analyse

Prøv en PDF-analyse uden en konto. Tilføj et token for at bruge din kontos grænser og gemme resultater.

POST/api/v1/pdf/analyze
Eksempel på forespørgsel
curl -X POST https://pdfcheck.online/api/v1/pdf/analyze \
  -H "Accept: application/json" \
  -F "file=@document.pdf"

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

Autentificering
Valgfrit
Uploadgrænse
50 MB
Basis-URL
https://pdfcheck.online/api/v1

Autentificering

Et token er valgfrit til PDF-analyse. Kontooplysninger, gemte analyser og tokenadministration kræver et Bearer-token.

Hold tokens hemmelige. Brug en miljøvariabel, og tilbagekald ubrugte tokens på din konto. Administrer API-tokens

Eksempel på forespørgsel
curl -X POST https://pdfcheck.online/api/v1/pdf/analyze \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PDFCHECK_API_TOKEN" \
  -F "file=@document.pdf"

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

Brug og grænser

Uden konto: 10 analyser om dagen pr. IP-adresse. Free: 100 om dagen. Pro og AI: ingen daglig grænse. Behandlingsendepunkter har også en grænse på 30 forespørgsler pr. minut. Analysesvar indeholder antallet af resterende tjek.

AdgangDaglige analyserUploadgrænse
Intet token påkrævet1050 MB
Free10050 MB
Pro / AIIngen daglig grænse100 MB

Behandlingsendepunkter accepterer også op til 30 forespørgsler pr. minut. Et 429-svar kan betyde en daglig grænse eller en minutgrænse.

POST/pdf/analyze

Upload og analyser en PDF-fil. Returnerer detaljeret metadata fra PDF-filen.

NavnTypeBeskrivelse
filemultipart/form-dataPåkrævet. PDF-fil til analyse: op til 50 MB uden konto og med Free; 100 MB med Pro og AI.

Eksempel på svar; værdierne afhænger af dokumentet.

Eksempel på svar
{
    "success": true,
    "data": {
        "id": "example-analysis-token",
        "view_key": "example-view-key",
        "filename": "document.pdf",
        "file_size": 1048576,
        "file_size_formatted": "1.00 MB",
        "metadata": {
            "basic": {
                "pages": 10,
                "pdf_version": "1.7",
                "analysis_mode": "lightweight",
                "partial_analysis": true
            },
            "document": {
                "title": "Example document",
                "author": "Example author",
                "creator": "Microsoft Word",
                "producer": "Adobe PDF Library"
            }
        },
        "analyzed_at": "2026-09-29T12:00:00+00:00"
    },
    "remaining_checks": 9
}

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

API-metadataanalyse bruger en begrænset, letvægtsfunktion. Detaljeret analyse af skrifttyper, billeder og farver springes over; metadata.basic.partial_analysis er true.

Metadata og softwareindikatorer beviser ikke forfatterskab, ægthed eller overholdelse af standarder.

Den uploadede fils data slettes efter behandlingen; analyseresultater og metadata kan blive gemt. Se privatlivspolitikken. Privatlivspolitik

GET/user

Hent oplysninger om den autentificerede bruger, inklusive daglige brugsgrænser.

Token påkrævet. Eksempel på svar; værdierne afhænger af dokumentet.

Eksempel på svar
{
    "success": true,
    "data": {
        "name": "Example user",
        "email": "user@example.com",
        "daily_limit": 100,
        "remaining_checks": 99,
        "checks_used_today": 1
    }
}

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

GET/pdf

Vis alle PDF-analyser for den autentificerede bruger med sideinddeling.

Token påkrævet

ForespørgselsparametreStandardBeskrivelse
per_page20Antal resultater pr. side (1-100)
page1integer
Eksempel på svar
{
    "success": true,
    "data": [
        {
            "id": "example-analysis-token",
            "filename": "document.pdf",
            "file_size": 1048576,
            "file_size_formatted": "1.00 MB",
            "analyzed_at": "2026-09-29T12:00:00+00:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 20,
        "total": 1
    }
}

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

GET/pdf/{token}

Hent detaljerede analyseresultater ud fra analyse-ID'et (delingstoken).

Token påkrævet

Eksempel på forespørgsel
curl https://pdfcheck.online/api/v1/pdf/example-analysis-token \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PDFCHECK_API_TOKEN"

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

Endepunktreference

POST/pdf/extract-text

Udtræk tekst fra en PDF. Send filen i feltet pdf; dette endepunkt har en uploadgrænse på 50 MB og returnerer data.pages.

Eksempel på forespørgsel
curl -X POST https://pdfcheck.online/api/v1/pdf/extract-text \
  -H "Accept: application/json" \
  -F "pdf=@document.pdf"

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

POST/pdf/to-markdown

Konvertér en PDF til Markdown. Send filen i feltet pdf (grænse på 50 MB). Separat kvote: 10 konverteringer om dagen uden konto og med Free; 100 om dagen med Pro og AI. Scannede sider kan bruge ekstern AI OCR. Svaret indeholder remaining_conversions.

Eksempel på forespørgsel
curl -X POST https://pdfcheck.online/api/v1/pdf/to-markdown \
  -H "Accept: application/json" \
  -F "pdf=@document.pdf"

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

Tokenhåndtering

Oprettelse af tokens via API kræver et eksisterende token. Opret dit første token på din konto. Administrer API-tokens

SlutpunkterBeskrivelse
GET /tokensVis alle API-tokens for den autentificerede bruger.
POST /tokensOpret et nyt API-token. Tokenet vises kun én gang i svaret. name: string (max: 255)
DELETE /tokens/{tokenId}Tilbagekald (slet) et API-token permanent.
Eksempel på forespørgsel
curl -X POST https://pdfcheck.online/api/v1/tokens \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PDFCHECK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"My integration"}'

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

Fejlkoder

HTTP-kodeFejlkodeBeskrivelse
401Unauthenticated.Ugyldigt eller manglende API-token
404not_foundRessource ikke fundet eller adgang nægtet
422message / errors
corrupted_pdf
password_protected
analysis_failed
Ugyldig forespørgsel eller fejl ved PDF-behandling, herunder en ikke-understøttet fil, for stor upload, beskadiget PDF eller adgangskodebeskyttelse
429daily_limit_exceeded
message
Daglig grænse eller minutgrænse overskredet; prøv igen, når den relevante grænse nulstilles

Kodeeksempler

Læs resultatet fra data.metadata.basic.pages. Alle svarudsnit er eksempler.

Node.js 20 eller nyere; bruger indbygget fetch, FormData og Blob.

analyze-pdf.mjs
import { readFile } from 'node:fs/promises';

const form = new FormData();
form.append('file', new Blob([await readFile('document.pdf')], {
  type: 'application/pdf'
}), 'document.pdf');

const headers = { Accept: 'application/json' };
if (process.env.PDFCHECK_API_TOKEN) {
  headers.Authorization = `Bearer ${process.env.PDFCHECK_API_TOKEN}`;
}

const response = await fetch('https://pdfcheck.online/api/v1/pdf/analyze', {
  method: 'POST', headers, body: form
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(JSON.stringify(result));
console.log(result.data.metadata.basic.pages);
console.log(result.remaining_checks);

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

Python (requests)
Python
import os
import requests

headers = {'Accept': 'application/json'}
if os.getenv('PDFCHECK_API_TOKEN'):
    headers['Authorization'] = f"Bearer {os.environ['PDFCHECK_API_TOKEN']}"

with open('document.pdf', 'rb') as pdf:
    response = requests.post(
        'https://pdfcheck.online/api/v1/pdf/analyze',
        headers=headers,
        files={'file': ('document.pdf', pdf, 'application/pdf')},
        timeout=120,
    )
response.raise_for_status()
result = response.json()
print(result['data']['metadata']['basic']['pages'])
print(result['remaining_checks'])

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.

PHP (cURL)
PHP
<?php
$headers = ['Accept: application/json'];
if ($token = getenv('PDFCHECK_API_TOKEN')) {
    $headers[] = 'Authorization: Bearer ' . $token;
}
$curl = curl_init('https://pdfcheck.online/api/v1/pdf/analyze');
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => ['file' => new CURLFile('document.pdf', 'application/pdf')],
]);
$body = curl_exec($curl);
if ($body === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
$result = json_decode($body, true, flags: JSON_THROW_ON_ERROR);
if ($status >= 400 || !($result['success'] ?? false)) {
    throw new RuntimeException($body);
}
echo $result['data']['metadata']['basic']['pages'];

Kopiering mislykkedes. Markér koden, og kopiér den manuelt.