الانتقال إلى المحتوى الرئيسي
يتيح لك Gorelo التكامل مع أي منتج خارجي عبر Gorelo API. يستخدم Gorelo API مفاتيح API. أدرج مفتاحك في كل طلب عبر ترويسة X-API-Key. يعتمد عنوان URL الأساسي لـ Gorelo على المنطقة التي اخترت استضافة بياناتك عليها في Gorelo:
تستخدم صفحات نقاط النهاية في مرجع API عنوان URL الأساسي للولايات المتحدة افتراضيًا. إذا كانت بياناتك مستضافة في أستراليا، فانقر على عنوان URL الأساسي في أعلى صفحة نقطة النهاية وحدد https://api.aue.gorelo.io.
قائمة عنوان URL الأساسي في صفحة نقطة نهاية مع تحديد https://api.aue.gorelo.io

أمثلة على الطلبات

توضّح مقتطفات JavaScript fetch التالية كيفية المصادقة باستخدام ترويسة X-API-Key. استبدل YOUR_API_KEY بمفتاحك واستبدل عنوان URL الأساسي بالمنطقة التي تستضيف بياناتك.
GET
POST

النطاقات والصلاحيات

يمكن أن تكون مفاتيح API محددة النطاق. إذا كان المفتاح يفتقر إلى الوصول لنقطة نهاية معينة، تُرجع واجهة API الخطأ 403 Forbidden. يمنح نطاق Documents المفتاح حق الوصول إلى المستندات.

الحقول المخصصة

تتضمن الحقول المخصصة في استجابات API الحقلين IsSet وIsHidden. لإبقاء قيمة حقل مخصص خارج API، فعّل Hide Value from API لهذا الحقل.

سجل الاستيراد

عند استيراد سجلات بقيمة CreatedOn بتاريخ سابق، لا يرسل Gorelo أي إشعارات ولا يشغّل أي عمليات أتمتة.
يحفظ Gorelo إدخالات الوقت التي تستوردها باستخدام CreatedOn بحالة Completed، لذا لن تتم فوترتها. لا يمكنك تغييرها أو حذفها عبر API بعد ذلك.

معالجة الأخطاء

معرّفات الحالات

الأصول الوكيلة

ملاحظات حول الحقول والقيم

التنبيهات

تحدد التنبيهات الأصل المرتبط بها باستخدام AgentAssetId أو CustomAssetId أو UptimeId. استخدم الحقول نفسها لتصفية التنبيهات.
DeviceId وUptimeCheckId اسمان مستعاران مهملان لـ AgentAssetId وUptimeId. حدّث عمليات التكامل لديك لاستخدام أسماء الحقول الحالية.

العقود والفواتير

  • حقول العقد: تُرجع استجابات العقود DaysUntilDue، وUnitCost في البنود، وAutoApproveTime في بند الخدمة.
  • أسعار بنود العقد: يُرجع UnitPrice في بند العقد السعر المفروض فعليًا، وليس سعر الكتالوج.
  • البنود القابلة للفوترة: يفوتر POST /v1/invoices البنود من نوع No charge وNon-billable بقيمة 0. أرسل BillableStatusId بالقيمة 1 للبنود التي يجب تحصيل رسومها.
  • الضريبة: تحصل بنود الفواتير والعقود التي لا تحتوي على TaxId على الضريبة التي كان التطبيق سيطبقها. لعدم فرض أي ضريبة، أرسل معرّف معدل الإعفاء الضريبي الخاص بك.
  • حذف العقود: يُلغي DELETE /v1/contracts/{contractId} تنشيط العقد، كما يفعل التطبيق، بحيث يمكنك استعادته. لأرشفة العقد بدلًا من ذلك، أرسل PATCH مع StatusId بالقيمة 3.

أنواع العناصر المرتبطة بالمستندات

نوع العنصر المرتبط 4 في المستندات هو Agent asset. تستمر عمليات التكامل التي تطابق حسب معرّف النوع في العمل. يجب على عمليات التكامل التي تطابق حسب اسم النوع استخدام Agent asset.