Команды cURL — это отличный способ передачи данных с помощью URL-адресов. Команды cURL рекомендуются для использования API из терминалов командной строки. Они не только позволяют нам делать обычные запросы, но и публиковать данные форм, аутентифицировать пользователей, сохранять ответы в файлах и выполнять другие операции по обработке файлов. Проще говоря, curl — это утилита командной строки для передачи данных с сервера или на сервер, предназначенная для работы без взаимодействия с пользователем. С помощью curl вы можете загружать или выгружать данные с помощью одного из поддерживаемых протоколов, включая HTTP, HTTPS, SCP, SFTP и FTP.

Тем не менее, это также облегчает нам тестирование RESTfull API.

Используемые команды cURL

ПОЛУЧАТЬ

Самый простой и распространенный запрос/операция, выполняемая с использованием HTTP, — это GET URL. При использовании этой команды мы отправляем запрос и получаем ресурсы с определенного URL (в нашем случае — документа).

ПОЧТА

Запрос по умолчанию — GET, но если у нас есть требование использовать ту же команду cURL для отправки данных форм, нам нужно использовать запрос POST. Поэтому в этой статье мы будем использовать ту же команду POST для отправки текстового контента. Обратите внимание, что для отправки данных мы используем параметр -d (или –data) с командой cURL.

ПОМЕЩАТЬ

Мы можем столкнуться с требованием обновить существующие данные, поэтому для этой цели используется метод PUT. Чтобы выполнить это требование, нам нужно использовать -X PUT в команде cURL, где X должен быть в верхнем регистре.

Для получения дополнительной информации посетите руководство по cURL.

Примечание: при использовании команд cURL убедитесь, что вы не ставите лишний пробел после обратной косой черты , иначе команда не будет выполнена и будут отображены ошибки.

Настройка cURL на Mac

В этой статье мы будем использовать команды cURL на macOS для вставки и обновления объектов Header Footer в документе MS Word с помощью терминального приложения. Поэтому для начала работы первым делом необходимо установить cURL на macOS. Откройте приложение Terminal в категории Others на панели запуска или нажмите Command+Space и введите Terminal, а затем нажмите клавишу Enter/Return. Самый простой способ установить cURL — использовать Homebrew, и по этой причине сначала вам нужно настроить Homebrew на вашем компьютере Mac. Введите следующую команду в командной строке терминала и нажмите клавишу Enter.

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null

Теперь получите пакет brew для cURL с помощью следующей команды.

 brew install curl

Готово! Теперь вы можете использовать curl.

Авторизуйте учетную запись Aspose.Cloud

Чтобы начать работу с API Aspose.Cloud, первым шагом является аутентификация вашей учетной записи и получение JWT в ответ. Если у вас нет учетной записи, вы можете создать ее на панели управления Aspose.Cloud или зарегистрироваться через существующую учетную запись Google или GitHub и начать использовать наши API Cloud.

// First get JSON Web Token for authentication
// Get App Key and App SID from https://dashboard.aspose.cloud/
curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=[APP_SID]&client_secret=[APP_KEY]" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

Cloud Aspose.Words

Aspose предлагает API для управления документами MS Word, и вы получаете возможность использовать Cloud API, On-Premise API или Cross-platform Apps для обработки документов Word. В этом блоге мы сделали акцент на Cloud API, которые предоставляют нам возможности для создания, управления и преобразования документов MS Word в облаке. Для работы с файлами MS Word не требуется загрузка или установка специального программного обеспечения.

Семейство продуктов Aspose.Cloud предоставляет набор облачных SDK, ориентированных на популярные языки программирования, включая .NET, Java, PHP, Python, Node.js, Android, C++, Ruby, Swift и Go. Все эти SDK являются оболочкой вокруг Aspose.Words Cloud REST API, а команды cURL являются одним из самых простых и легких способов доступа к REST API через командную строку/терминал.

В этом блоге мы делаем акцент на использовании команд cURL для управления разделами верхнего и нижнего колонтитула в файлах MS Word при доступе к API Aspose.Words Cloud.

Загрузить документ Word

После выполнения аутентификации следующим шагом будет загрузка файла в облачное хранилище. Используя следующую команду cURL, файл загружается в хранилище по умолчанию в InputFolder.

curl -v -X PUT "https://api.aspose.cloud/v4.0/words/storage/file/InputFolder" \
-H "accept: application/json" \
-H "authorization: Bearer <jwt token>" \
-F document=@BusinessLetter2.docx
Вывод консоли при загрузке файла в облачное хранилище

Сообщение об успешной загрузке файла в облачное хранилище.

Теперь, чтобы подтвердить наличие файла в облачном хранилище, откройте вкладку «Мои файлы» на dashboard.aspose.cloud. Мы можем заметить, что в списке появилась новая папка с именем InputFolder, содержащая BusinessLetter2.docx.

Недавно созданная папка и файл загружены в облачное хранилище

Вставить объект заголовка

После загрузки документа мы можем либо вставить новый объект Header или Footer, либо получить доступ к существующему объекту и обновить его свойства. В настоящее время API Aspose.Words Cloud поддерживает следующие типы объектов Header и Footer.

Следующая команда показывает, как вставить объект HeaderFirst в документ Word, уже доступный в облачном хранилище в папке InputFolder.

curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/headersfooters?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "'HeaderFirst'" \
-H "Content-Type: application/json"

После выполнения указанной выше команды на консоли отобразится список разделов документа Word.

Разделы верхнего и нижнего колонтитулов обычно содержат текст, изображения и т. д. В следующей команде мы вставим образец текста в первый абзац внутри объекта заголовка, созданного выше.

curl -v -X POST "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/sections/0/headersFooters/1/paragraphs?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Text': 'Aspose.Words Cloud .NET SDK' }" \
-H "Content-Type: application/json"

Обновить форматирование текста объекта «Заголовок»

После вставки текста мы можем обновить свойства шрифта текста. Поскольку документ Word может содержать много текстовых экземпляров, для обновления текста нам нужно указать точный путь. Поэтому, если нам нужно обновить свойства шрифта для вставленного выше текста, который вставлен поверх sections/0/headersfooters/1/paragraphs/0/runs/0, то нам нужно использовать следующую команду.

Обратите внимание, что теперь, когда мы собираемся обновить свойства шрифта уже размещенных объектов, нам нужно использовать команду PUT.

curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/sections/0/headersFooters/1/paragraphs/0/runs/0/font?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Bold':true, 'Size': 21.0, 'Name': 'Calibri',  'Color': { 'Web': '#f54269', 'Alpha': 0 } }" \
-H "Content-Type: application/json"

Вставить номер страницы в нижний колонтитул

Одним из важных применений объектов Header и Footer является отображение информации о номере страницы, и при использовании Aspose.Words Cloud мы можем легко выполнить это требование. API также предоставляет возможности указать место, где необходимо отобразить штамп PageNumber. Как показано в команде ниже, мы указали, что нужно добавить информацию PageNumber, которая будет отображаться в правом верхнем углу страницы, а также отобразить ее на первой странице документа.

curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/PageNumbers?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Format': '{PAGE} of {NUMPAGES}', 'Alignment': 'right', 'IsTop': false, 'SetPageNumberOnFirstPage': true }" \
-H "Content-Type: application/json"

Подобно обновлению свойств шрифта для экземпляра Header, мы также можем обновить свойства шрифта объекта Footer, который содержит информацию PageNumber. Поскольку информация о номере страницы состоит из трех объектов run (runs/0, runs/2 и runs/3), нам нужно обновить команду обновления шрифта три раза для каждого экземпляра run.

curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/sections/0/headersFooters/3/paragraphs/1/runs/3/font?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Bold':true, 'Size': 21.0, 'Name': 'Arial', 'Shadow': true, 'Color': { 'Web': '#f5b642', 'Alpha': 0 } }" \
-H "Content-Type: application/json"

После выполнения всех вышеперечисленных команд результирующий документ будет выглядеть примерно так, как показано на изображении выше.

Для вашего сведения также прилагаются образцы документов: