Как предоставить DocuSign PDF?

Question

Мы используем Python и библиотеку запросов, чтобы добавить файлы PDF в DocuSign конверты с использованием Add document метода REST API v2:

response = requests.put(
    '<base URL>/envelopes/<envelope ID>/documents/<next document ID>', 
    files={'document': <the PDF file object>}, # <- added to the request's body 
    headers=self._get_headers(
     { 
      'Content-Disposition': 'document; filename="the-file.pdf";' 
     } 
    ), 
    timeout=60 
) 

Это работал у нас в большинстве случаев, за исключением того, что около 1 в 100 PDF-файлы не допускается через API. Когда эта проблема возникает, мы сообщаем нашим пользователям загружать PDF-файлы непосредственно через пользовательский интерфейс DocuSign, который работает. Это побудило нас (с помощью поддержки) посмотреть ссылку Document params, которая появляется над примером запроса на странице Add document, указанной выше. На странице показан атрибут documentBase64 и ряд других полей. Как я могу предоставить документ в этом формате со всеми указанными полями? Должен ли я заменить файл в моем вызове выше на files={'document': <JSON-encoded object>} или? Я не могу понять, как добавить документ OTHER, чем тот, который мы сейчас делаем. Есть ли другой способ, который мне не хватает?

Answer 1

Похоже, что есть два различных способа добавления документа в проект конверта с REST API:

1. Использование запроса нескольких частей, где первая часть содержит тело JSON и каждый последующая часть содержит байты документа - в некодированный формат. Пример такого подхода показан на страницах 136-137 руководства API REST (http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf).

2. Используйте обычный запрос (т.е. не из нескольких частей запроса), и подача документов байт в кодировке base64 формат в качестве значения собственности documentBase64 для каждого документа объекта в запросе , (Это выглядит новым, как в недавнем декабре 2013 года выпуска API/обновления.)

Основываясь на информации, вы включены в ваш вопрос, я подозреваю, что вы используете подход # 1. Как описано выше, основное различие между двумя подходами заключается в общей структуре запроса, а ALSO - подход №1 ожидает, что байты документа будут некодированы, а подход №2 ожидает, что байты документа будут закодированы в base64. Я подозреваю, что ваша проблема связана с кодировкой файлов. то есть, если вы используете подход №1, и любой из файлов закодирован, у вас могут возникнуть проблемы.