API Документация

    Интегрируйте File Converter в ваше приложение с помощью REST API

    API Ключ

    Используйте API ключ для доступа к API. Храните его в безопасности.

    У вас еще нет API ключа. Создайте его, чтобы начать использовать API.

    Как использовать:

    1. Скопируйте ваш API ключ
    2. Добавьте его в заголовок Authorization: Bearer YOUR_API_KEY
    3. Используйте API согласно документации

    Базовый URL

    https://okdocs.io

    Аутентификация

    Все запросы требуют API ключ в заголовке Authorization

    curl -H "Authorization: Bearer YOUR_API_KEY" \
  -X POST "https://okdocs.io/api/pdf/merge" \
  -F "files=@file1.pdf" \
  -F "files=@file2.pdf"

    Endpoints

    POST
    /api/pdf/merge

    Объединить несколько PDF файлов в один

    Параметры:

    files
    MultipartFile[]
    Required

    Массив PDF файлов (минимум 2)

    Ответ:

    FileResponse

    Пример запроса:

    curl -X POST "https://okdocs.io/api/pdf/merge" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"
    POST
    /api/pdf/split

    Разделить PDF файл на несколько файлов

    Параметры:

    file
    MultipartFile
    Required

    PDF файл

    ranges
    String
    Required

    Диапазоны страниц (например: "1-3,5,7-9")

    Ответ:

    FileResponse[]

    Пример запроса:

    curl -X POST "https://okdocs.io/api/pdf/split" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"
    POST
    /api/html/file

    Конвертировать HTML файл в PNG или PDF

    Параметры:

    file
    MultipartFile
    Required

    HTML файл

    format
    String
    Required

    Формат вывода: "png" или "pdf"

    Ответ:

    FileResponse

    Пример запроса:

    curl -X POST "https://okdocs.io/api/html/file" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"
    POST
    /api/html/url

    Конвертировать URL в PNG или PDF

    Параметры:

    url
    String
    Required

    URL веб-страницы

    format
    String
    Required

    Формат вывода: "png" или "pdf"

    Ответ:

    FileResponse

    Пример запроса:

    curl -X POST "https://okdocs.io/api/html/url" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"
    POST
    /api/convert/docx-to-pdf

    Конвертировать DOCX документ в PDF (асинхронно, 202 Accepted)

    Параметры:

    file
    MultipartFile
    Required

    DOCX файл (application/vnd.openxmlformats-officedocument.wordprocessingml.document)

    Ответ:

    JobResponse

    Пример запроса:

    curl -X POST "https://okdocs.io/api/convert/docx-to-pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"
    POST
    /api/convert/xlsx-to-pdf

    Конвертировать XLSX таблицу в PDF (асинхронно, 202 Accepted)

    Параметры:

    file
    MultipartFile
    Required

    XLSX файл (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)

    Ответ:

    JobResponse

    Пример запроса:

    curl -X POST "https://okdocs.io/api/convert/xlsx-to-pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"
    POST
    /api/convert/pptx-to-pdf

    Конвертировать PPTX презентацию в PDF (асинхронно, 202 Accepted)

    Параметры:

    file
    MultipartFile
    Required

    PPTX файл (application/vnd.openxmlformats-officedocument.presentationml.presentation)

    Ответ:

    JobResponse

    Пример запроса:

    curl -X POST "https://okdocs.io/api/convert/pptx-to-pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@example.pdf"

    Лимиты запросов

    • Free: 10 запросов в минуту
    • Pro: 100 запросов в минуту
    • Business: 1000 запросов в минуту

    Коды ошибок

    400 - Bad Request
    401 - Unauthorized
    413 - File Too Large
    500 - Internal Server Error