Autenticación

Todas las solicitudes a la API requieren autenticación mediante una clave de API enviada como token Bearer en el encabezado Authorization.

Claves de API

Las claves de API identifican su cuenta y registran el uso en relación con los límites de su plan. Cada clave tiene acceso completo a las funciones de API de su cuenta.

Crear una clave de API

Genere claves de API desde su panel. Puede crear varias claves y revocarlas de forma individual en cualquier momento.

Usar su clave de API

Incluya su clave de API en el encabezado Authorization de cada solicitud:

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

Respuestas de error

401 Unauthorized

Se devuelve cuando la clave de API falta o no es válida.

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

403 Forbidden

Se devuelve cuando la clave de API es válida pero no tiene permiso para el recurso solicitado.

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

Buenas prácticas de seguridad

Guarde las claves de API en variables de entorno, nunca en el código fuente
Nunca incluya claves de API en el control de versiones (añádalas al .gitignore)
Use claves de API separadas para desarrollo y producción
Rote las claves de forma periódica y revoque cualquiera que pueda haber quedado expuesta
Nunca exponga las claves de API en el código del lado del cliente - llame siempre a la API desde su servidor