Вступ до REST API

REST API Scriptum дозволяє зовнішнім системам працювати з документами платформи без участі користувача в інтерфейсі. Наприклад, через API можна створити документ із файлом, отримати дані документа або завантажити його основний файл.

Примітка:

Детальна документація REST API доступна англійською мовою.

Можливості API

Група запитів	Що можна зробити
Document types	Отримати список типів документів і опис окремого типу.
Documents	Створити документ, отримати його дані, завантажити або отримати основний файл документа.
Uploads	Передати файл на сервер одним запитом або частинами, з можливістю продовжити передавання після збою. Переданий файл можна вказати як основний під час створення документа.

Автентифікація

Кожен запит до API повинен містити API-ключ у заголовку Authorization:

Authorization: Bearer <API-ключ>

• Користувач створює ключ у розділі My API Keys меню користувача. Ключі для службових користувачів інтеграцій створює супервізор.
• Ключ відображається лише один раз — під час створення.
• Запит виконується з правами користувача, якому належить ключ. Для роботи з REST API ключ повинен мати область доступу rest.
• Система відхиляє з кодом 403 відкликаний або прострочений ключ, ключ вимкненого користувача та ключ без області доступу rest.

Детальніше див. у розділі Authentication.

З чого почати

1. Отримайте API-ключ в розділі My API Keys меню користувача.
2. Ознайомтеся із загальними правилами API на сторінці Overview: формат помилок і дат, вибір полів відповіді та завантаження файлів.
3. У бічному меню виберіть потрібний запит. На сторінці кожного запиту наведено параметри, схеми відповідей і приклади коду для cURL, Python, Node.js, C# і Java.