با استفاده از وب سرویس تبدیل پی دی اف به ورد یا عکس به متن توسعه دهندگان می توانند فایل های عکس یا PDF خود در هر فرمتی را برای API آی او ورد (Persian OCR API) ارسال کرده و متن تایپی آن را دریافت نمایند. برای استفاده از این API می بایست ابتدا اعتبار صفحات حساب کاربری خود را افزایش داده و سپس اقدام به دریافت API_TOKEN نمایید.
با ارسال هر فایل شامل عکس یا PDF نرم افزار در پاسخ یک کد پیگیری TRACKING_CODE برای شما ارسال کرده و فایل ارسالی شما در صف پردازش و تبدیل قرار خواهد گرفت. با استفاده از وب سرویس track شما می توانید وضعیت هر درخواست تبدیل را با استفاده از ارسال TRACKING_CODE مرتبط با آن پیگیری نمایید و در پایان در صورت اتمام فرآیند تبدیل ، شما می توانید با استفاده از وب سرویس download اقدام به دریافت متن تبدیل شده به صورت TXT یا DOCX نمایید.
برای ارسال فایل عکس یا PDF به OCR API می توانید از آدرس زیر استفاده نمایید.
POST : https://www.ioword.com/developer/convert
پارامتر | مقدار | ضروری ؟ | نوع | توضیحات |
---|---|---|---|---|
Authorization | API TOKEN | بله | رشته (String) | پارامتر Authorization را در هدر درخواست ارسال نمایید. مقدار این پارامتر API TOKEN دریافتی از ioword است. |
Accept | application/json | بله | رشته (String) | |
X-Requested-With | XMLHttpRequest | بله | رشته (String) |
پارامتر | ضروری ؟ | توضیحات |
---|---|---|
file | الزامی (برای تبدیل از طریق آپلود فایل) | در صورتی که قصد بارگذاری فایل در سرور ioword دارید فایل خود را انتخاب نمایید. |
در صورت خطا در اتصال ، خروجی به صورت زیر خواهد بود:
{ "status": 100, "data": { "status": "failed", "tracking_code": null } }
در صورت موفقیت آمیز بودن اتصال ، خروجی به صورت زیر خواهد بود:
{ "status": 100, "data": { "status": "uploaded", "tracking_code": "TRACKING_CODE" } }
در صورت موفقیت آمیز بودن درخواست فوق ، شما می بایست TRACKING_CODE را برای پیگری وضعیت و دانلود متن تبدیل شده ، ذخیره نمایید. به منظور پیگیری وضعیت تبدیل فایل PDF به متن می بایست از API پیگیری وضعیت استفاده کرد. برای استفاده از این API می بایست TRACKING_CODE دریافتی از API بارگذاری فایل را در این API استفاده نمایید.
POST : https://www.ioword.com/developer/convert/track
پارامتر | مقدار | ضروری ؟ | نوع | توضیحات |
---|---|---|---|---|
Authorization | API TOKEN | بله | رشته (String) | پارامتر Authorization را در هدر درخواست ارسال نمایید. مقدار این پارامتر API TOKEN دریافتی از ioword است. |
Accept | application/json | بله | رشته (String) | |
X-Requested-With | XMLHttpRequest | بله | رشته (String) |
پارامتر | ضروری ؟ | توضیحات |
---|---|---|
tracking_code | الزامی | کد پیگیری دریافتی از API بارگذاری فایل PDF |
در صورت خطا در اتصال ، خروجی به صورت زیر خواهد بود:
{ "status": 0, "message": "invalid tracking code", "data": null }
در صورت موفقیت آمیز بودن اتصال ، خروجی به صورت زیر خواهد بود:
{ "status": 100, "data": { "status": "converted", "tracking_code": "TRACKING_CODE" } }
وضعیت های مختلف فایل در فرآیند تبدیل (status) به صورت زیر می باشد.
وضعیت | توضیحات |
---|---|
uploaded | فایل بارگذاری شده است و هنوز وارد صف تبدیل نشده است. |
processing | فایل در صف تبدیل قرار گرفته و در حال پردازش می باشد. |
converted | فایل تبدیل شده و امکان دریافت متن تبدیل شده وجود دارد. |
failed | در فرآیند تبدیل فایل به متن خطایی رخ داده است. |
پس از قرارگیری فایل مورد نظر در وضعیت converted امکان دریافت آن فراهم می باشد. برای این منظور می بایست از وب سرویس download استفاده نمایید. با استفاده از این وب سرویس می بایست TRACING_CODE و format مورد نظر برای دانلود نتیجه را ارسال نمایید. فرمت های قابل استفاده در این سرویس txt و docx می باشند.
POST : https://www.ioword.com/developer/convert/download
پارامتر | مقدار | ضروری ؟ | نوع | توضیحات |
---|---|---|---|---|
Authorization | API TOKEN | بله | رشته (String) | پارامتر Authorization را در هدر درخواست ارسال نمایید. مقدار این پارامتر API TOKEN دریافتی از ioword است. |
Accept | application/json | بله | رشته (String) | |
X-Requested-With | XMLHttpRequest | بله | رشته (String) |
پارامتر | ضروری ؟ | توضیحات |
---|---|---|
tracking_code | الزامی | کد پیگیری دریافتی از API بارگذاری فایل PDF |
format | الزامی | فرمت دریافت نتیجه تبدیل (docx یا txt) |
به منظور دریافت اعتبار باقی مانده از صفحات قابل تبدیل می توانید از وب سرویس زیر استفاده نمایید.
POST : https://www.ioword.com/developer/inventory
پارامتر | مقدار | ضروری ؟ | نوع | توضیحات |
---|---|---|---|---|
Authorization | API TOKEN | بله | رشته (String) | پارامتر Authorization را در هدر درخواست ارسال نمایید. مقدار این پارامتر API TOKEN دریافتی از ioword است. |
Accept | application/json | بله | رشته (String) | |
X-Requested-With | XMLHttpRequest | بله | رشته (String) |
تمامی توسعه دهندگان می توانند از رابط نرم افزاری IoWord به عنوان تنها رابط نرم افزاری فارسی در این زمینه استفاده نمایند. نرم افزارهای تولید شده مبتنی بر رابط نرم افزار IoWord تحت حمایت کامل ما بوده و مجموعه IoWord از تمامی ظرفیت های خود برای توسعه بستر مناسب برای ارایه این سرویس استفاده خواهد کرد. پشتیبانی نرم افزار IoWord به صورت آنلاین می باشد. همچنین در صورت بروز مشکل در اتصال یا درخواست راهنمایی در زمینه اتصال به API، کارشناسان فنی از طریق آدرس ایمیل info@ioword.com یا پشتیبانی تلگرام iotype_support امکان بررسی تخصصی سوالات شما را خواهند داشت.