API Start
Автоматизированная система преобразования дизайна в готовый для печати макет.
Включает в себя:
- input WF - пребразование разных форматов файлов в PDF.
- pre-production WF - преобразование любого дизайна в готовый для печати макет.
- production WF - размещение макета/макетов на спуске/печатном столе.
Welcome to b2b.2pdfx API.
b2b.2pdfx API
Files processing
Общая логика работы с b2b.2pdfx API.
Вы принимаете файл на своей стороне, записываете на свой сервер.
Через API вы передаете нам на обработку файл и размеры продукта, мы производим обработку.
После обработки файла мы возвращаем объект Job, в котором есть ссылки на: финальный обработанный ПДФ-файл, подробный репорт о результатах обработки с маркерами Success, Warning, Error, None, а также финальные JPEG превью по одному на каждую страницу.
Адрес сервера для осуществления запросов https://b2b.2pdfx.com/api-v1.
Архитектура - server -> server
Тестовая страница API RESTful Test
1. Авторизация и получение токена
2. Создание Job-а для обработки файла.
3. Получение информации о процессинге файла (файлов).
4. В случае удачной обработки, получение ссылок на файл, превью, репорт. В случае неудачной обработки - получение Job статуса.
1. Авторизация.
Action | HTTP Verb | URL |
---|---|---|
Login & get token |
n/a |
api/login?email=***&pwd=*** |
Пример запроса:
https://b2b.2pdfx.com/api-v1/login?email=test@b2b.2pdfx.printonline.com.ua&pwd=test
Параметры запроса:
Param |
Type |
Description |
---|---|---|
|
String(254) |
В качестве логина используется email. Ваш email авторизованый в https://b2b.2pdfx.com |
pwd |
String(160) |
пароль |
Пример ответа JSON:
{
"result":true,
"token":"nQvd1cNgIiEiwxh6744Mg6XVCSkGkAhvkvtMdAqcEjRiHmxXs7eP9n4IveP043H4",
"expire":1454961100,
"message":"Logged in",
"code":0
}
Параметры ответа:
Param |
Type |
Description |
result |
Boolean |
true - успешная авторизация false - не успешная авторизация |
token |
String(64) |
временный ключ |
expire |
Int |
Timestamp время истечения срока действия ключа |
message |
String |
Logged in. Authentication fail. Token invalid. Token expired. |
code |
Int |
AUTH_CODE_LOGGED_IN = 0; AUTH_CODE_LOGIN_FAIL = 1; AUTH_CODE_TOKEN_INVALID = 2; AUTH_CODE_TOKEN_EXPIRED = 3; |
2. Создание Job-а для обработки файла.
Action |
HTTP Verb |
URL |
Create a record |
POST |
api/Job |
Пример запроса:
https://b2b.2pdfx.com/api-v1/Job?token=ad46e0a479366a643578fumXWU.DauK.MSQHMMg8CUduLYGnaSwMK
Post:
Headers:
Content-Type: application/json; charset=utf-8
Source:
{
"SourceURL" : "https://b2b.2pdfx.com/assets/shoes.jpg",
"Width" : 90,
"Height" : 50
}
Параметры запроса:
Param |
Type |
Description |
SourceURL |
String(512) |
URL на файл который должен быть обработан в b2b.2pdfx |
Width |
Float |
размер продукта в мм |
Height |
Float |
размер продукта в мм |
Пример успешного ответа JSON:
{
"SourceURL" : "https://b2b.2pdfx.com/test.tiff",
"Width" : 90,
"Height" : 50,
"Progress" : 0,
"Message" : "WAITING",
"MessageType" : "None",
"ID" : 130
}
Пример неуспешного ответа JSON:
{
"SourceURL" : "https://b2b.2pdfx.com/error.tiff",
"Width" : 90,
"Height" : 50,
"Progress" : 0,
"Message" : "403",
"MessageType" : "Error",
"Details" : "SourceURL is empty file",
"ID" : 133
}
Параметры Job-a:
Param |
Type |
Description |
ID |
Int |
Уникальный идентификатор |
SourceURL |
String(512) |
URL по которому сервис b2b.2pdfx скачивает файл для обработки |
DestURL |
String(512) |
URL по которому сервис b2b.2pdfx выкладывает файл после обработки |
Width |
Float |
ширина, используется для приведения макета в формат продукта в мм |
Height |
Float |
высота, используется для приведения макета в формат продукта в мм |
Progress |
Float |
отображение состояния обработки в процентах от 0 до 100 |
Message |
String(512) |
сообщения о состоянии и результате обработки Возможные значения: IDLE (None)– без действия, ожидание очереди WAITING (None) – работа в очереди появилась, ожидание запуска процессинга PROCESSING (None) – файл обрабатывается COMPLETED_SUCCESSFULLY (Success, Warning)– файл успешно обработан CANCELED (None) – обработка файла было отменена COMPLETED_WITH_ERROR (Error) – файл не обработан, ошибка b2b.2pdfx процессора Empty SourceURL (Error) – пустой URL, невозможно скачать файл
|
MessageType |
String(40) |
тип сообщения Возможные значения: None Неклассифицированное сообщение, просто сообщение Success Файл успешно обработан Notice Warning Файл успешно обработан, но есть предупреждения. Детали в report.xml Warning. Логика отработки статусов Warning – на стороне сервера клиента. Мы рекомендуем выдавать сообщение подобное «Ваш файл содержит такие ошибки (список предупреждений), даю согласие на обработку файла вручную».
Error Ошибка обработки файла Error. По нашей текущей статистике Error (невозможность обработать файл) – меньше 1% и связано с битыми, недозагруженными файлами.
|
Details |
Text |
Текстовое сообщение |
Reports |
Array |
Список репортов (PublicFile) |
Previews |
Array |
Список репортов (PublicFile) |
Параметры PublicFile
Param |
Type |
Description |
ID |
Int |
Уникальный идентификатор |
URL |
String(512) |
Публичный URL для скачивания файла |
3. Получение информации о процессинге Job-a
Action |
HTTP Verb |
URL |
Find 1 record |
GET |
api/Job/ID |
Пример запроса:
https://b2b.2pdfx.com/api-v1/Job/134?token=79793f7fb465ef5649cfeehHp4L30g2cghsgPpt3paK.UL9HnEL52
{
"SourceURL":"https://b2b.2pdfx.com/test.tiff",
"DestURL":"https://b2b.2pdfx.com/public-url/download/tN8NkYElljrt7BlWtb4vqgNB/test[2].tiff",
"Width":90,
"Height":50,
"Progress":100,
"Message":"COMPLETED_SUCCESSFULLY",
"MessageType":"Success",
"ID":133,
"Reports":[
{
"URL":"https://b2b.2pdfx.com/public-url/download/r9aMKbk83aOxtA0b4LFCgpk8K9O/report.xml"
}
],
"Previews":[
{
"URL":"https://b2b.2pdfx.com/public-url/download/rdcNPihDr4XpJjL2KfalB6PMbkdr8OlA/test[2]_1.jpg"
},
{
"URL":"https://b2b.2pdfx.com/public-url/download/xoRQGuiLsIuLtxvJIRlOG801/test[2]_2.jpg"
}
]
}
Параметры ответа: