عميل GrabzIt مع Node.js

الوصف

يعالج هذا الفصل كل الاتصالات مع خدمات الويب GrabzIt screenshot.

الطرق العامة

get_result(id)
url_to_animation(url, options)
url_to_image(url, options)
html_to_image(html, options)
file_to_image(path, options)
url_to_pdf(url, options)
html_to_pdf(html, options)
file_to_pdf(path, options)
url_to_docx(url, options)
html_to_docx(html, options)
file_to_docx(path, options)
url_to_table(url, options)
html_to_table(html, options)
file_to_table(path, options)
url_to_rendered_html(url, options)
html_to_rendered_html(html, options)
file_to_rendered_html(path, options)
save(callBackUrl, oncomplete)
save_to(saveToFile, oncomplete)
get_status(id, oncomplete)
get_cookies(domain, oncomplete)
set_cookie(name, domain, options, oncomplete)
delete_cookie(name, domain, oncomplete)
get_watermarks(oncomplete)
get_watermark(identifier, oncomplete)
add_watermark(identifier, path, xpos, ypos, oncomplete)
delete_watermark(identifier, oncomplete)
set_local_proxy(value)
use_ssl(value)
create_encryption_key()
decrypt(data, key)
decrypt_file(path, key, oncomplete)

get_result (معرف)

هذه الطريقة تقوم بإرجاع لقطة الشاشة نفسها. إذا لم يتم إرجاع أي شيء ، فقد حدث خطأ ما أو أن لقطة الشاشة ليست جاهزة بعد.

المعلمات

معرف - المعرف الفريد للشاشة
- مطلوب:

url_to_animation(موقع المعلومات العالمي، الخيارات)

حدد عنوان URL للفيديو عبر الإنترنت الذي يجب تحويله intيا المتحركة GIF.

المعلمات

عنوان url - عنوان URL لتحويل الفيديو عبر الإنترنت intس المتحركة GIF
- مطلوب:
- يقبل عنوان URL لفيديو Vimeo و YouTube
  - يعتمد تحذير تنشيط مقاطع فيديو Vimeo و YouTube على جهة خارجية وبالتالي قد لا يوفر نتائج متسقة.
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند إنشاء GIF متحركة.

قيمة الإرجاع

باطل

خيارات الرسوم المتحركة

جميع الخيارات المتاحة عند إنشاء صورة GIF متحركة.

customId - معرف مخصص يمكنك تمريره إلى خدمة الويب GIF المتحركة. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
- الافتراضي: فارغ
width - عرض GIF المتحركة الناتجة بالبكسل.
- الافتراضي: 180px
- الحد الأقصى: أقصى عرض للحزمة
- الحجم التلقائي: -1 (تمرير -1 يعني أن عرض يتم تحجيم GIF المتحركة فيما يتعلق بارتفاعه ، إذا كان حجم العرض تلقائيًا ، فلن يتمكن الارتفاع من ذلك)
height - ارتفاع GIF المتحركة الناتجة بالبكسل.
- الافتراضي: 120px
- الحد الأقصى: أقصى ارتفاع للحزمة
- الحجم التلقائي: -1 (تمرير -1 يعني أن ارتفاع يتم تحجيم GIF المتحركة فيما يتعلق بعرضه ، إذا كان الارتفاع يتم تلقائيًا ، فلا يمكن للعرض)
start - موضع بدء الفيديو الذي يجب تحويله intيا المتحركة GIF.
- الافتراضي: 0 ثانية
duration - طول ثواني الفيديو التي يجب تحويلها intيا المتحركة GIF.
- الافتراضي: الحد الأقصى لطول الحزمة
speed - سرعة GIF المتحركة.
- الافتراضي: 1
- الحد الأدنى: 0.2
- الحد الأقصى: 10
framesPerSecond - عدد الإطارات في الثانية التي يجب التقاطها من الفيديو.
- الافتراضي: 10
- الحد الأدنى: 0.2
- الحد الأقصى: 60
repeat - عدد مرات تكرار حلقة GIF المتحركة.
- الافتراضي: 0
- حلقة مستمرة: 0
- أبدا التكرار: -1
reverse - إذا كان هذا صحيحًا ، يتم عكس إطارات GIF المتحركة
- الافتراضي: خطأ
customWaterMarkId - اضافة العرف watermark إلى GIF المتحركة
- الافتراضي: فارغ
quality - ال جودة الصورة التي تم إرجاعهاالذي يحتوي على ضغط افتراضي قدره 85٪.
- إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
- الافتراضي: -1
- الحد الأدنى: -1
- الحد الأقصى: 100
country - البلد GIF المتحركة يجب أن تؤخذ من.
- الافتراضي: الموقع الحالي الأسرع
- الخيارات: "SG" ، "UK" ، "US"
exportUrl - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
- الافتراضي: فارغ
encryptionKey - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، فسيتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
- الافتراضي: فارغ
proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
- الافتراضي: فارغ

مثال على الخيارات

{
    'width':250,
    'height':250,
    'speed':2
}

url_to_image(موقع المعلومات العالمي، الخيارات)

يحدد عنوان URL الذي يجب تحويله intيا صورة لقطة للشاشة.

المعلمات

عنوان url - عنوان URL الذي يجب أن تكون لقطة الشاشة منه
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند إنشاء لقطة الشاشة.

قيمة الإرجاع

باطل

html_to_image(أتش تي أم أل، الخيارات)

يحدد HTML الذي يجب تحويله intيا صورة.

المعلمات

أتش تي أم أل - HTML لتحويل intيا صورة
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة.

قيمة الإرجاع

باطل

file_to_image(مسار، الخيارات)

يحدد ملف HTML الذي يجب تحويله intيا صورة.

المعلمات

المسار - مسار ملف ملف HTML لتحويله intيا صورة
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامها عند إنشاء صورة.

قيمة الإرجاع

باطل

خيارات الصورة

جميع الخيارات المتاحة عند إنشاء التقاط الصور.

customId - معرف مخصص يمكنك نقله إلى لقطة شاشة webservice. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
- الافتراضي: فارغ
browserWidth - عرض المتصفح بالبكسل
- الافتراضي: 1366
- الحد الأقصى: 10000
browserHeight - ارتفاع المتصفح بالبكسل
- الافتراضي: 1170
- الحد الأقصى: 10000
- الطول الكامل: -1 (تمرير -1 يعني أنه تم التقاط صورة نصية لصفحة الويب بالكامل)
width - عرض الصورة المصغرة الناتجة بالبكسل
- الافتراضي: إذا لم يتم تحديد كل من عرض الإخراج وارتفاع الإخراج أو 0 ، فسيتم مطابقة عرض وارتفاع الإخراج مع عرض الصورة النهائية وارتفاعها ، إذا تم تحديد ارتفاع الإخراج ، فسيكون عرض الإخراج متناسبًا مع ارتفاع الإخراج
- الحد الأقصى: أقصى عرض للحزمة
- العرض الكامل: -1 (تمرير -1 يعني أنه لا يتم تقليل عرض الصورة المصغرة)
height - ارتفاع الصورة المصغرة الناتجة مم
- الافتراضي: إذا لم يتم تحديد كل من عرض الإخراج وارتفاع الإخراج أو 0 ، فسيتم مطابقة عرض وارتفاع الإخراج مع عرض الصورة النهائية وارتفاعها ، إذا تم تحديد عرض الإخراج ، فسيكون ارتفاع الإخراج متناسبًا مع عرض الإخراج
- الحد الأقصى: أقصى ارتفاع للحزمة
- الطول الكامل: -1 (تمرير -1 يعني أنه لا يتم تقليل ارتفاع الصورة المصغرة)
format - الشكل الذي يجب أن تكون عليه لقطة الشاشة.
- الافتراضي: "jpg"
- الخيارات: "bmp8" ، "bmp16" ، "bmp24" ، "bmp" ، "tiff" ، "webp" ، "jpg" ، "png"
delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
- الافتراضي: 0
- الحد الأقصى: 30000
clickElement - هذا يحدد عنصر HTML ، باستخدام ملف محدد CSS للنقر. تذكر أن التأخير قد يكون مطلوبًا أيضًا لعرض تأثيرات النقرة
- تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
targetElement - ال محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intoa لقطة شاشة ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
- الافتراضي: فارغ
hideElement - ال محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
- الافتراضي: فارغ
waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
- الافتراضي: فارغ
requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
- الافتراضي: 0
- خيارات:
  - 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
  - 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
  - 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
customWaterMarkId - إضافة العرف watermark على الصورة
- الافتراضي: فارغ
quality - ال جودة الصورة التي تم إرجاعها. لا يؤثر هذا حاليًا إلا على صور JPG و WEBP ، والتي لها ضغط افتراضي بنسبة 90٪.
- إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
- الافتراضي: -1
- الحد الأدنى: -1
- الحد الأقصى: 100
transparent - إذا كان صحيحا يجب أن يكون التقاط الصور شفافًا. هذا متوافق فقط مع صور بابوا نيو غينيا وتيف.
- الافتراضي: خطأ
hd - إذا كانت الصورة حقيقية سوف يكون التقاط في عالية الوضوح هذا يضاعف حجم أبعاد الصورة.
- الافتراضي: خطأ
country - البلد لقطة ينبغي أن تؤخذ من.
- الافتراضي: الموقع الحالي الأسرع
- الخيارات: "SG" ، "UK" ، "US"
exportUrl - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
- الافتراضي: فارغ
encryptionKey - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، فسيتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
- الافتراضي: فارغ
noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
- الافتراضي: خطأ
noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
- الافتراضي: خطأ
address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
- الافتراضي: فارغ
post - يحدد استعلام HTTP Poststring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر. باستخدام هذا الخيار سوف يجبر GrabzIt على أداء وظيفة HTTP.
- الافتراضي: فارغ
proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
- الافتراضي: فارغ

مثال على الخيارات

{
    'width':500,
    'height':500
}

url_to_rendered_html(موقع المعلومات العالمي، الخيارات)

يحدد عنوان URL الذي يجب تحويله intس المقدمة HTML.

المعلمات

عنوان url - عنوان URL الذي يجب أن يتكون منه HTML
- مطلوب:
الخيارات - كائن JSON الذي يحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدم.

قيمة الإرجاع

باطل

html_to_rendered_html(أتش تي أم أل، الخيارات)

يحدد HTML الذي يجب تحويله intس المقدمة HTML.

المعلمات

أتش تي أم أل - HTML لتحويل intس المقدمة HTML
- مطلوب:
الخيارات - كائن JSON الذي يحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدمة.

قيمة الإرجاع

باطل

file_to_rendered_html(مسار، الخيارات)

يحدد ملف HTML الذي يجب تحويله intس المقدمة HTML.

المعلمات

المسار - مسار ملف ملف HTML لتحويله intس المقدمة HTML
- مطلوب:
الخيارات - كائن JSON الذي يحدد أي خيارات خاصة لاستخدامها عند إنشاء HTML المقدمة.

قيمة الإرجاع

باطل

خيارات HTML

جميع الخيارات المتاحة عندما خلق يلتقط HTML المقدمة.

customId - معرف مخصص يمكنك تمريره إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
- الافتراضي: فارغ
browserWidth - عرض المتصفح بالبكسل
- الافتراضي: 1366
- الحد الأقصى: 10000
browserHeight - ارتفاع المتصفح بالبكسل
- الافتراضي: 1170
- الحد الأقصى: 10000
delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
- الافتراضي: 0
- الحد الأقصى: 30000
clickElement - هذا يحدد عنصر HTML ، باستخدام ملف محدد CSS للنقر. تذكر أن التأخير قد يكون مطلوبًا أيضًا لعرض تأثيرات النقرة
- تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
- الافتراضي: فارغ
requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
- الافتراضي: 0
- خيارات:
  - 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
  - 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
  - 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
country - البلد لقطة ينبغي أن تؤخذ من.
- الافتراضي: الموقع الحالي الأسرع
- الخيارات: "SG" ، "UK" ، "US"
exportUrl - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
- الافتراضي: فارغ
encryptionKey - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، فسيتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
- الافتراضي: فارغ
noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
- الافتراضي: خطأ
noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
- الافتراضي: خطأ
address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
- الافتراضي: فارغ
post - يحدد استعلام HTTP Poststring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر. باستخدام هذا الخيار سوف يجبر GrabzIt على أداء وظيفة HTTP.
- الافتراضي: فارغ
proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
- الافتراضي: فارغ

مثال على الخيارات

{
    'country':'SG',
    'delay':5000
}

url_to_pdf(موقع المعلومات العالمي، الخيارات)

يحدد عنوان URL الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

عنوان url - عنوان URL الذي يجب تحويله intيا قوات الدفاع الشعبي
- مطلوب:
الخيارات - كائن JSON الذي يحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

html_to_pdf(أتش تي أم أل، الخيارات)

يحدد HTML الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

أتش تي أم أل - HTML لتحويل intيا قوات الدفاع الشعبي
- مطلوب:
الخيارات - كائن JSON الذي يحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

file_to_pdf(مسار، الخيارات)

يحدد ملف HTML الذي يجب تحويله intيا قوات الدفاع الشعبي.

المعلمات

المسار - مسار ملف ملف HTML لتحويله intيا قوات الدفاع الشعبي
- مطلوب:
الخيارات - كائن JSON الذي يحدد أي خيارات خاصة لاستخدامها عند إنشاء PDF.

قيمة الإرجاع

باطل

خيارات PDF

جميع الخيارات المتاحة عند إنشاء PDF يلتقط.

customId - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
- الافتراضي: فارغ
includeBackground - إذا كان هذا صحيحًا ، يجب تضمين خلفية صفحة الويب في لقطة الشاشة
- الافتراضي: صحيح

pagesize - حجم صفحة PDF
- الافتراضي: "A4"
- الخيارات: "A3" ، "A4" ، "A5" ، "A6" ، "B3" ، "B4" ، "B5" ، "B6" ، "قانوني" ، "خطاب"
orientation - اتجاه وثيقة PDF
- الافتراضي: "عمودي"
- خيارات: "بورتريه" ، "أفقي"
cssMediaType - ال CSS Media نوع مستند PDF
- الشاشة الافتراضية"
- خيارات: "الشاشة" ، "العلاقات العامةint"
includeLinks - صحيح إذا كانت الروابط يجب أن تدرج في PDF
- الافتراضي: صحيح
includeOutline - صحيح إذا قوات الدفاع الشعبي الإشارات المرجعية ينبغي أن تدرج
- الافتراضي: خطأ
title - تقديم عنوان لمستند PDF
- الافتراضي: فارغ
coverUrl - عنوان URL لصفحة الويب التي يجب استخدامها كصفحة غلاف لملف PDF
- الافتراضي: فارغ
marginTop - الهامش بالمليمترات التي يجب أن تظهر في الجزء العلوي من صفحة وثيقة PDF
- الافتراضي: 10
marginLeft - الهامش بالمليمترات التي يجب أن تظهر على يسار صفحة مستند PDF
- الافتراضي: 10
marginBottom - الهامش بالمليمترات التي يجب أن تظهر في أسفل صفحة وثيقة PDF
- الافتراضي: 10
marginRight - الهامش بالمليمترات التي يجب أن تظهر على يمين مستند PDF
- الافتراضي: 10
browserWidth - ال عرض المتصفح بالبكسل
- تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
- الافتراضي: 1366
- الحد الأقصى: 10000
- العرض التلقائي: -1 (تمرير -1 يعني أن عرض المستعرض يطابق عرض مستند PDF)
pageWidth - ال عرض مخصص لملف PDF الناتج في ملم
- الافتراضي: مقاس الصفحه عرض
- الحد الأدنى: 15
pageHeight - ال ارتفاع مخصص لقوات الدفاع الشعبي الناتجة في ملم
- الافتراضي: مقاس الصفحه ارتفاع
- الحد الأدنى: 15
delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
- الافتراضي: 0
- الحد الأقصى: 30000
requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
- الافتراضي: 0
- خيارات:
  - 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
  - 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
  - 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
templateId - أضف قالب المعرف الذي يحدد رأس وتذييل مستند PDF
- الافتراضي: فارغ
clickElement - هذا يحدد عنصر HTML ، باستخدام ملف محدد CSS للنقر. تذكر أن التأخير قد يكون مطلوبًا أيضًا لعرض تأثيرات النقرة
- تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
targetElement - ال محدد CSS من فقط عنصر HTML في صفحة الويب الهدف التي سيتم تشغيلها intيا قوات الدفاع الشعبي، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
- الافتراضي: فارغ
hideElement - ال محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
- الافتراضي: فارغ
waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
- الافتراضي: فارغ
customWaterMarkId - إضافة العرف watermark لكل صفحة من صفحات وثيقة PDF
- الافتراضي: فارغ
quality - ال جودة PDF عاد. يستخدم الإعداد الافتراضي الجودة الموصى بها لملف PDF.
- إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
- الافتراضي: -1
- الحد الأدنى: -1
- الحد الأقصى: 100
country - البلد لقطة ينبغي أن تؤخذ من.
- الافتراضي: الموقع الحالي الأسرع
- الخيارات: "SG" ، "UK" ، "US"
exportUrl - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
- الافتراضي: فارغ
encryptionKey - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، فسيتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
- الافتراضي: فارغ
noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
- الافتراضي: خطأ
noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
- الافتراضي: خطأ
address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
- الافتراضي: فارغ
post - يحدد استعلام HTTP Poststring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر. باستخدام هذا الخيار سوف يجبر GrabzIt على أداء وظيفة HTTP.
- الافتراضي: فارغ
templateVariables - يعرف أ قالب مخصص المعلمة والقيمة كاستعلامstring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر.
- الافتراضي: فارغ
proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
- الافتراضي: فارغ
mergeId - معرف الالتقاط الذي يجب أن يكون دمجها في بداية وثيقة PDF الجديدة
- الافتراضي: فارغ
password - ال كلمة مرور لحماية وثيقة PDF من خلال خاصية الترجمة لي
- الافتراضي: فارغ

مثال على الخيارات

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_docx(موقع المعلومات العالمي، الخيارات)

يحدد عنوان URL الذي يجب تحويله intيا DOCX.

المعلمات

عنوان url - عنوان URL الذي يجب تحويله intيا DOCX
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند إنشاء DOCX.

قيمة الإرجاع

باطل

html_to_docx(أتش تي أم أل، الخيارات)

يحدد HTML الذي يجب تحويله intيا DOCX.

المعلمات

أتش تي أم أل - HTML لتحويل intيا DOCX
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند إنشاء DOCX.

قيمة الإرجاع

باطل

file_to_docx(مسار، الخيارات)

يحدد ملف HTML الذي يجب تحويله intيا DOCX.

المعلمات

المسار - مسار ملف ملف HTML لتحويله intيا DOCX
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند إنشاء DOCX.

قيمة الإرجاع

باطل

خيارات DOCX

جميع الخيارات المتاحة عند إنشاء لقطات DOCX.

customId - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته.
- الافتراضي: فارغ
includeBackground - إذا كان هذا صحيحًا ، يجب تضمين الصور الخلفية لصفحة الويب في DOCX
- الافتراضي: صحيح
pagesize - حجم صفحة DOCX
- الافتراضي: "A4"
- الخيارات: "A3" ، "A4" ، "A5" ، "A6" ، "B3" ، "B4" ، "B5" ، "B6" ، "قانوني" ، "خطاب"
orientation - اتجاه وثيقة DOCX
- الافتراضي: "عمودي"
- خيارات: "بورتريه" ، "أفقي"
includeLinks - صحيح إذا كانت الروابط يجب أن تدرج في DOCX
- الافتراضي: صحيح
includeImages - إذا كان هذا صحيحًا ، يجب تضمين صور صفحة الويب في DOCX
- الافتراضي: صحيح
title - تقديم عنوان لوثيقة DOCX
- الافتراضي: فارغ
marginTop - الهامش بالمليمترات التي يجب أن تظهر في أعلى صفحة مستند DOCX
- الافتراضي: 10
marginLeft - الهامش بالمليمترات التي يجب أن تظهر على يسار صفحة مستند DOCX
- الافتراضي: 10
marginBottom - الهامش بالمليمترات التي يجب أن تظهر في أسفل صفحة مستند DOCX
- الافتراضي: 10
marginRight - الهامش بالمليمترات التي يجب أن تظهر على يمين مستند DOCX
- الافتراضي: 10
browserWidth - ال عرض المتصفح بالبكسل
- تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
- الافتراضي: 1366
- الحد الأقصى: 10000
- العرض التلقائي: -1 (تمرير -1 يعني أن عرض المستعرض يطابق عرض مستند DOCX)
pageWidth - ال عرض مخصص لل DOCX الناتجة في ملم
- الافتراضي: مقاس الصفحه عرض
- الحد الأدنى: 15
pageHeight - ال ارتفاع مخصص لل DOCX الناتجة في ملم
- الافتراضي: مقاس الصفحه ارتفاع
- الحد الأدنى: 15
delay - عدد المللي ثانية إلى انتظر قبل التقاط لقطة الشاشة
- الافتراضي: 0
- الحد الأقصى: 30000
requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
- الافتراضي: 0
- خيارات:
  - 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
  - 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
  - 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
templateId - أضف قالب المعرف الذي يحدد رأس وتذييل مستند DOCX
- الافتراضي: فارغ
clickElement - هذا يحدد عنصر HTML ، باستخدام ملف محدد CSS للنقر. تذكر أن التأخير قد يكون مطلوبًا أيضًا لعرض تأثيرات النقرة
- تحذير هذه الميزة حاليًا في مرحلة تجريبية وقد لا توفر نتائج متسقة.
targetElement - ال محدد CSS من عنصر HTML الوحيد على صفحة الويب المستهدفة المراد تشغيلها intيا DOCX ، يتم تجاهل جميع الأجزاء الأخرى من صفحة الويب. إذا كان هناك عناصر HTML مطابقة متعددة يتم اختيار أول عنصر
- الافتراضي: فارغ
hideElement - ال محددات CSS واحد أو أكثر من عناصر HTML في صفحة الويب المراد إخفاؤها ، لتحديد عناصر HTML متعددة لإخفاء فصل كل محدد بفاصلة
- الافتراضي: فارغ
waitForElement - ال محددات CSS من عنصر HTML في صفحة الويب التي يجب أن تكون مرئية قبل تنفيذ الالتقاط
- الافتراضي: فارغ
quality - ال جودة DOCX عاد. الجودة الافتراضية للصور في DOCX هي 85٪.
- إن تقليل الجودة سيقلل حجم الملف ويقلل أوقات التنزيل.
- الافتراضي: -1
- الحد الأدنى: -1
- الحد الأقصى: 100
country - البلد لقطة ينبغي أن تؤخذ من.
- الافتراضي: الموقع الحالي الأسرع
- الخيارات: "SG" ، "UK" ، "US"
exportUrl - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
- الافتراضي: فارغ
encryptionKey - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، فسيتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
- الافتراضي: فارغ
noAds - إذا كان هذا صحيحا يجب أن تكون الإعلانات مخفية تلقائيًا.
- الافتراضي: خطأ
noCookieNotifications - إذا كان هذا صحيحا كل شيء شائع يجب أن تكون إعلامات ملفات تعريف الارتباط مخفية تلقائيًا.
- الافتراضي: خطأ
address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
- الافتراضي: فارغ
post - يحدد استعلام HTTP Poststring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر. باستخدام هذا الخيار سوف يجبر GrabzIt على أداء وظيفة HTTP.
- الافتراضي: فارغ
templateVariables - يعرف أ قالب مخصص المعلمة والقيمة كاستعلامstring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر.
- الافتراضي: فارغ
proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
- الافتراضي: فارغ
mergeId - معرف الالتقاط الذي يجب أن يكون دمجها في بداية وثيقة DOCX الجديدة
- الافتراضي: فارغ
password - ال كلمة المرور لحماية وثيقة DOCX من خلال خاصية الترجمة لي
- الافتراضي: فارغ

مثال على الخيارات

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_table(موقع المعلومات العالمي، الخيارات)

يحدد عنوان URL الذي يجب استخراج جداول HTML منه.

المعلمات

عنوان url - عنوان URL لاستخراج جداول HTML من
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند تحويل جدول HTML.

قيمة الإرجاع

باطل

html_to_table(أتش تي أم أل، الخيارات)

يحدد HTML الذي يجب استخراج جداول HTML منه.

المعلمات

أتش تي أم أل - HTML لاستخراج جداول HTML من.
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند تحويل جدول HTML.

قيمة الإرجاع

باطل

file_to_table(مسار، الخيارات)

يحدد ملف HTML الذي يجب استخراج جداول HTML منه.

المعلمات

المسار - مسار ملف ملف HTML لاستخراج جداول HTML من.
- مطلوب:
الخيارات - كائن JSON يحدد أي خيارات خاصة لاستخدامه عند تحويل جدول HTML.

قيمة الإرجاع

باطل

خيارات الجدول

جميع الخيارات المتاحة عند تحويل جداول HTML إلى CSV أو XLSX أو JSON.

customId - معرف مخصص يمكنك نقله إلى خدمة الويب. سيتم إرجاع ذلك بعنوان URL الخاص بالرد الذي حددته
- الافتراضي: فارغ
tableNumberToInclude - فهرس الجدول المطلوب تحويله ، إذا كانت جميع الجداول في صفحة الويب مرتبة من أعلى صفحة الويب إلى أسفل
- الافتراضي: 1
format - يجب أن يكون الجدول في
- الافتراضي: "CSV"
- خيارات: "CSV" ، "json" ، "xlsx"
includeHeaderNames - إذا تم إدراج أسماء الرؤوس الحقيقية في الجدول
- الافتراضي: صحيح
includeAllTables - إذا كان هذا صحيحًا ، فسيتم استخراج كل جدول في صفحة الويب مع ظهور كل جدول في ورقة بيانات منفصلة. متوفر فقط بتنسيق XLSX
- الافتراضي: خطأ
targetElement - معرف عنصر HTML الوحيد في صفحة الويب التي يجب استخدامها لاستخراج الجداول من
- الافتراضي: فارغ
requestAs - نوع وكيل المستخدم الذي ترغب في استخدامه
- الافتراضي: 0
- خيارات:
  - 0 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح قياسي
  - 1 = يشير إلى أنه يجب استخدام وكيل المستخدم لمتصفح الجوال
  - 2 = يشير إلى أنه يجب استخدام وكيل المستخدم لمحرك البحث
country - البلد لقطة ينبغي أن تؤخذ من.
- الافتراضي: الموقع الحالي الأسرع
- الخيارات: "SG" ، "UK" ، "US"
exportUrl - ال عنوان URL للتصدير الذي يحدد حيث يجب أن يتم تصدير الالتقاط أيضا
- الافتراضي: فارغ
encryptionKey - إذا تم تحديد مفتاح تشفير AES تشفير 64 أساسي ، فسيتم تشفير الالتقاط عند إنشائه. فمن المستحسن استخدام إنشاء طريقة مفتاح التشفير لإنشاء المفتاح و فك تشفير الطرق لفك تشفير الالتقاط المشفر كما هو موضح في هذا المثال.
- الافتراضي: فارغ
post - يحدد استعلام HTTP Poststring. كل اسم وقيمة في الاستعلامstring سوف تحتاج إلى أن يكون عنوان URL المشفر. باستخدام هذا الخيار سوف يجبر GrabzIt على أداء وظيفة HTTP.
- الافتراضي: فارغ
address - عنوان URL لتنفيذ تعليمات HTML البرمجية فيه. يمكن أن يكون مفيدًا في حالة استخدام HTML الجاري تحويله عناوين URL النسبية لموارد مثل CSS والصور.
- الافتراضي: فارغ
proxy - تفاصيل وكيل HTTP يجب أن يستخدم برنامج المتصفح لاستخدام هذا الالتقاط
- الافتراضي: فارغ

مثال على الخيارات

{
    'format':'xlsx',
    'includeHeaderNames':true
}

استخدام خيار callBackUrl هو الطريقة الموصى بها لحفظ الملف

save(callBackUrl ، oncomplete)

Save النتيجة بشكل غير متزامن وإرجاع معرف فريد ، والتي يمكن استخدامها للحصول على لقطة مع get_result الأسلوب.

المعلمات

callBackURL - معالج يجب على خدمة GrabzIt الاتصال بعد اكتمال عملها
oncomplete (خطأ ، معرف) - وظيفة رد الاتصال ، والتي تسمى عندما يتم استرداد معرف لقطة الشاشة.

save_to(saveToملف ، غير مكتمل)

Save النتيجة بشكل متزامن دون استخدام URL رد الاتصال.

المعلمات

saveToملف - مسار الملف الذي سيتم التقاطه saveد إلى بمجرد الانتهاء منه
oncomplete (خطأ ، بيانات) - وظيفة رد الاتصال ، والتي تسمى عند تنزيل لقطة الشاشة. تحتوي المعلمة البيانات على لقطات الشاشة.

get_status(معرف ، غير مكتمل)

الحصول على الوضع الحالي للشاشة GrabzIt.

المعلمات

معرف - المعرف الفريد للشاشة
- مطلوب:
oncomplete (خطأ، الحالة) - وظيفة رد الاتصال ، والتي تسمى عندما يتم استرداد حالة لقطة الشاشة.
- مطلوب:

get_cookies(المجال ، غير مكتمل)

احصل على جميع ملفات تعريف الارتباط التي يستخدمها GrabzIt لمجال معين. قد يشمل ذلك ملفات تعريف الارتباط المعرفة من قبل المستخدم.

المعلمات

المجال - المجال لإرجاع ملفات تعريف الارتباط لـ
- مطلوب:
oncomplete (خطأ، ملفات تعريف الارتباط ( الكوكيز ) ) - وظيفة رد الاتصال ، والتي تسمى عندما يتم استرداد ملفات تعريف الارتباط.
- مطلوب:

set_cookie (الاسم ، المجال ، الخيارات ، غير مكتمل)

يعين ملف تعريف ارتباط مخصص جديد على GrabzIt ، إذا كان ملف تعريف الارتباط المخصص يحمل نفس الاسم والمجال مثل ملف تعريف الارتباط العام ، يتم تجاوز ملف تعريف الارتباط العام.

قد يكون ذلك مفيدًا إذا كانت ملفات مواقع الويب تتحكم فيها ملفات تعريف الارتباط.

المعلمات

اسم - اسم ملف تعريف الارتباط لتعيين
- مطلوب:
المجال - مجال موقع الويب لتعيين ملف تعريف الارتباط لـ
- مطلوب:
الخيارات
- القيمة - قيمة ملف تعريف الارتباط
- المسار - مسار موقع الويب الذي يرتبط به ملف تعريف الارتباط
- httponly - إذا كان هذا صحيحًا ، فيمكن استخدام ملف تعريف الارتباط فقط مع بروتوكول HTTP
- تنتهي صلاحيته - يحدد وقت انتهاء صلاحية ملف تعريف الارتباط. تمرير قيمة فارغة إذا كان ملف تعريف الارتباط يجب أن لا تنتهي
```
{
    'value':'me@example.com',
    'httponly':false
}
```
oncomplete (خطأ ، نجاح) - وظيفة رد الاتصال ، والتي تسمى عندما يتم تعيين ملف تعريف الارتباط. تكون معلمة النجاح صحيحة إذا تم تعيين ملف تعريف الارتباط بنجاح ، وإلا كان خطأ

delete_cookie (الاسم ، المجال ، غير مكتمل)

حذف ملف تعريف ارتباط مخصص أو حظر ملف تعريف ارتباط عمومي من الاستخدام

المعلمات

اسم - اسم ملف تعريف الارتباط المراد حذفه
- مطلوب:
المجال - مجال موقع الويب لحذف ملف تعريف الارتباط لـ
- مطلوب:
oncomplete (خطأ ، نجاح) - وظيفة رد الاتصال ، والتي تسمى عندما يتم تعيين ملف تعريف الارتباط. تكون معلمة النجاح صحيحة إذا تم حذف ملف تعريف الارتباط أو خطأ.

احصل على_watermarks()

احصل على كل ما تبذلونه من تحميل مخصص watermarks

المعلمات

oncomplete (خطأ، watermarks) - وظيفة رد الاتصال ، والتي تُسمى عندما يكون ملف watermarks تم استرجاعها. ال watermark تحتوي المعلمة على مجموعة من watermarks.
- مطلوب:

احصل على_watermark(معرف ، غير مكتمل)

عودة العرف الخاص بك watermark الذي يطابق المعرف المحدد

المعلمات

المعرف - معرف مخصص معين watermark تريد المشاهدة
- مطلوب:
oncomplete (خطأ، watermarks) - وظيفة رد الاتصال ، والتي تُسمى عندما يكون ملف watermark تم استرجاعه. ال watermarks المعلمة تحتوي على watermark مجموعة مصفوفة.
- مطلوب:

أضفwatermark(المعرف ، المسار ، xpos ، ypos ، غير كامل)

إضافة العرف الجديد watermark

المعلمات

المعرف - المعرف الذي تريد منحه المخصص watermark. من المهم أن يكون هذا المعرف فريدًا.
- مطلوب:
المسار - المسار المطلق لملف watermark على الخادم الخاص بك. على سبيل المثال C: /watermark/1.png
- مطلوب:
xpos - الموضع الأفقي الذي تريد أن تظهر فيه لقطة الشاشة
- مطلوب:
- خيارات:
  - اليسار = 0
  - مركز = 1
  - اليمين = 2
ypos - الموضع الرأسي الذي تريد أن تظهر فيه لقطة الشاشة
- مطلوب:
- خيارات:
  - أعلى = 0
  - الأوسط = 1
  - أسفل = 2
oncomplete (خطأ ، نجاح) - وظيفة رد الاتصال ، والتي تُسمى عندما يكون ملف watermark تمت إضافة. يكون معامل النجاح صحيحًا إذا كان watermark تمت إضافة النحل بنجاح ، وإلا فهو خطأ.
- مطلوب:

حذف_watermark(معرف ، غير مكتمل)

حذف مخصص watermark

المعلمات

المعرّف - معرّف العرف watermark تريد حذفه
- مطلوب:
oncomplete (خطأ ، نجاح) - وظيفة رد الاتصال ، والتي تُسمى عندما يكون ملف watermark تم إزالته. يكون معامل النجاح صحيحًا إذا كان watermark تم حذفه بنجاح.
- مطلوب:

set_local_proxy (القيمة)

هذه الطريقة تمكن الخادم الوكيل المحلي ليتم استخدامها لجميع الطلبات.

المعلمات

القيمة - عنوان URL ، الذي يمكن أن يتضمن منفذًا إذا لزم الأمر ، من الوكيل. سيؤدي توفير قيمة خالية إلى إزالة أي وكيل تم تعيينه مسبقًا
- مطلوب:

use_ssl (القيمة)

يحدد ما إذا كانت طلبات GrabzIt يجب أن تستخدم API SSL

المعلمات

قيمة - إذا كان هذا صحيحًا ، فستستخدم جميع الطلبات إلى واجهة برمجة تطبيقات GrabzIt SSL
- مطلوب:

create_encryption_key ()

قم بإنشاء مفتاح تشفير 64 أساسي آمن مشفر بطول أحرف 44.

فك تشفير (البيانات ، مفتاح)

فك تشفير التقاط مشفر باستخدام مفتاح التشفير المقدم.

المعلمات

المسار - مسار الالتقاط المشفر
- مطلوب:
المفتاح - مفتاح التشفير
- مطلوب:

decrypt_file (المسار ، المفتاح ، غير مكتمل)

فك تشفير التقاط مشفر باستخدام مفتاح التشفير المقدم.

المعلمات

المسار - مسار الالتقاط المشفر
- مطلوب:
المفتاح - مفتاح التشفير
- مطلوب:
oncomplete (خطأ) - وظيفة رد الاتصال ، والتي تسمى عندما يتم فك تشفير الملف.

نتيجة الطبقات

كوكي

المتغيرات العامة

اسم - اسم ملف تعريف الارتباط
القيمة - قيمة ملف تعريف الارتباط
المجال - المجال الذي تم تعيين ملف تعريف الارتباط عليه
المسار - المسار على المجال الذي ينطبق عليه ملف تعريف الارتباط هذا.
httponly - إذا كان ملف تعريف الارتباط هذا صالحًا فقط عند عرض موقع الويب باستخدام بروتوكول HTTP.
تنتهي صلاحيته - تاريخ انتهاء صلاحية ملف تعريف الارتباط هذا
نوع - نوع ملف تعريف الارتباط هذا
- خيارات:
  - عالمي - هذا ملف تعريف ارتباط عالمي من إعداد GrabzIt
  - محلي - هذا ملف تعريف ارتباط محلي تم تعيينه بواسطتك
  - تجاوز - ملف تعريف ارتباط عمومي تم تجاوزه بواسطتك

الحالة

الطبقة التي تمثل الوضع الحالي للشاشة.

المتغيرات العامة

معالجة - إذا كان هذا صحيحًا ، فلا تزال لقطة الشاشة قيد المعالجة.
مخزنة مؤقتًا - إذا كان هذا صحيحًا ، فقد تمت معالجة لقطة الشاشة ويتم تخزينها مؤقتًا في الوقت الحالي.
انتهت صلاحيتها - إذا كان هذا صحيحًا ، فلم تعد لقطة الشاشة موجودة على نظام GrabzIt.
رسالة - رسالة خطأ عاد من قبل النظام.

WaterMark

هذه الفئة تمثل العادة watermarks مخزنة في GrabzIt

المتغيرات العامة

المعرّف - معرّف watermark
التنسيق - تنسيق ملف watermark صورة
xPosition - الموضع x الذي يحتويه watermark يظهر في في لقطة الشاشة
- خيارات:
  - اليسار = 0
  - مركز = 1
  - اليمين = 2
yPosition - الموضع y الذي يمثل watermark يظهر في في لقطة الشاشة
- خيارات:
  - أعلى = 0
  - الأوسط = 1
  - أسفل = 2