Authentification

Toutes les requêtes API nécessitent une authentification au moyen d’une clé API envoyée comme jeton Bearer dans l’en-tête Authorization.

Clés API

Les clés API identifient votre compte et suivent l’utilisation par rapport aux limites de votre offre. Chaque clé dispose d’un accès complet aux fonctionnalités API de votre compte.

Créer une clé API

Générez des clés API depuis votre tableau de bord. Vous pouvez créer plusieurs clés et les révoquer individuellement à tout moment.

Utiliser votre clé API

Incluez votre clé API dans l’en-tête Authorization de chaque requête :

cURL

curl -X POST https://api-parse.conversiontools.io/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.pdf"

Python

import requests

API_KEY = "YOUR_API_KEY"
headers = {"Authorization": f"Bearer {API_KEY}"}

with open("document.pdf", "rb") as f:
    response = requests.post(
        "https://api-parse.conversiontools.io/v1/extract",
        headers=headers,
        files={"file": f},
    )

data = response.json()
print(data["data"])

Node.js

const fs = require("fs");

const API_KEY = "YOUR_API_KEY";
const headers = { Authorization: `Bearer ${API_KEY}` };

const form = new FormData();
form.append("file", fs.createReadStream("document.pdf"));

const response = await fetch("https://api-parse.conversiontools.io/v1/extract", {
  method: "POST",
  headers,
  body: form,
});

const data = await response.json();
console.log(data.data);

Réponses d’erreur

401 Unauthorized

Renvoyée lorsque la clé API est manquante ou invalide.

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Forbidden

Renvoyée lorsque la clé API est valide mais ne dispose pas de l’autorisation pour la ressource demandée.

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "API key does not have access to this resource"
  }
}

Bonnes pratiques de sécurité

Stockez les clés API dans des variables d’environnement, jamais dans le code source
Ne validez jamais de clés API dans le gestionnaire de versions (ajoutez-les au .gitignore)
Utilisez des clés API distinctes pour le développement et la production
Renouvelez régulièrement les clés et révoquez toute clé qui aurait pu être exposée
N’exposez jamais de clés API dans le code côté client - appelez toujours l’API depuis votre serveur