بيئة التجربة والاختبار
تبني وتختبر تكاملك على شركة تجربة خاصة بك، فيها بيانات وهمية فقط. تنشئها بنفسك بضغطة زر، ولا تحتاج إلى التواصل مع أهلاً حمد.
إنشاء شركة التجربة
- سجّل الدخول إلى أهلاً حمد، أو أنشئ حساباً مجانياً.
- افتح التكاملات ← مفاتيح API واضغط إنشاء شركة تجربة (Create sandbox company).
- اختر الدولة: الكويت أو السعودية أو الإمارات أو قطر أو البحرين أو عُمان. العملة والمنطقة الزمنية وأيام نهاية الأسبوع وقواعد التأمينات تتبع الدولة التي تختارها.
- تصبح الرئيس التنفيذي للشركة (CEO) بالعضوية فقط، ولا تتغير شركتك الحالية. استخدم التبديل إلى شركة التجربة حين تريد العمل عليها.
- داخل شركة التجربة أنشئ مفتاح API واختر صلاحياته. يبدأ المفتاح بـ
ah_test_ويظهر مرة واحدة فقط، فانسخه فوراً.
curl https://actions.ahlanhamad.com/v1/company \
-H "Authorization: Bearer ah_test_…"لكل مستخدم شركة تجربة واحدة. إعادة ضبط شركة التجربة أو حذفها غير متاحة بعد.
ما الذي تحتويه شركة التجربة
- شركة باسم شركة التجربة للتجارة (
Sandbox Trading Co.) وكيان قانوني واحد في الدولة التي اخترتها، و"sandbox": trueفيGET /v1/company. - عشرة موظفين وهميين بأسماء واضحة أنها غير حقيقية، بأرقام موظفين من
SBX-001إلىSBX-010: ثلاثة مواطنين وسبعة وافدين، ثمانية بدوام كامل وواحد بدوام جزئي وواحد بعقد. - مسيّر رواتب واحد نهائي للشهر الماضي، محسوب بمحرّك الرواتب والتأمينات الفعلي في المنتج، مع قيد اليومية المرحّل — أي أن ما تقرؤه هو ما ستراه لدى شركة حقيقية.
- بيانات بنكية وأرقام هويات مولّدة للعرض داخل التطبيق فقط؛ الـ API لا يُرجع هذه الحقول أصلاً، لا في التجربة ولا في الإنتاج.
| رقم الموظف | المسمى الوظيفي | القسم | الجنسية | employment_type |
|---|---|---|---|---|
SBX-001 | المدير العام | Management | مواطن من بلد بيئة التجربة | full_time |
SBX-002 | مدير المالية | Finance | مواطن من بلد بيئة التجربة | full_time |
SBX-003 | موظفة موارد بشرية | Human Resources | مواطن من بلد بيئة التجربة | full_time |
SBX-004 | مدير المتجر | Retail | هندي | full_time |
SBX-005 | أمينة صندوق | Retail | فلبيني | full_time |
SBX-006 | أمين صندوق | Retail | مصري | full_time |
SBX-007 | أمينة صندوق | Retail | هندي | part_time |
SBX-008 | موظف مخزون | Retail | فلبيني | full_time |
SBX-009 | سائق | Operations | باكستاني | full_time |
SBX-010 | محاسبة | Finance | أردني | contract |
قواعد مفاتيح التجربة
- مفتاح
ah_test_يعمل مع شركات التجربة فقط، ومفتاحah_live_مع الشركات الحقيقية فقط. استخدام النوع الخطأ يُرجع401 unauthenticated. - نفس نقاط النهاية ونفس الصلاحيات ونفس حدّ الطلبات (600 طلب في الدقيقة لكل مفتاح افتراضياً).
- أحداث الويب هوك من شركة تجربة تحمل
"livemode": false. - شركة التجربة لا تُعامل كعميل: لا اشتراك ولا فواتير ولا رسائل تسويقية أو تذكيرات.
- لا تُدخل بيانات أشخاص حقيقيين في شركة التجربة. هي مساحة اختبار، وكل ما فيها يجب أن يبقى وهمياً.
ما يمكنك استدعاؤه اليوم
القائمة التالية مولّدة من openapi.yaml: العمليات المعلَّمة بأنها متاحة الآن، والعمليات المنشورة في العقد التي لم تُطلق بعد.
| العملية | الإصدار | الحالة |
|---|---|---|
GET /v1/company | v1.0 | متاح |
GET /v1/employees | v1.0 | قريباً |
GET /v1/employees/{employee_id} | v1.0 | قريباً |
GET /v1/payroll-runs | v1.0 | قريباً |
GET /v1/payroll-runs/{payroll_run_id} | v1.0 | قريباً |
POST /v1/attendance/events | v1.1 | قريباً |
GET /v1/attendance | v1.1 | قريباً |
GET /v1/webhooks | v1.2 | قريباً |
POST /v1/webhooks | v1.2 | قريباً |
GET /v1/webhooks/{webhook_id} | v1.2 | قريباً |
PATCH /v1/webhooks/{webhook_id} | v1.2 | قريباً |
DELETE /v1/webhooks/{webhook_id} | v1.2 | قريباً |
POST /v1/webhooks/{webhook_id}/test | v1.2 | قريباً |
GET /v1/webhooks/{webhook_id}/deliveries | v1.2 | قريباً |
POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver | v1.2 | قريباً |
تابع سجل التغييرات لمعرفة ما يُطلق. لتجربة كل نقاط النهاية بسرعة، استورد مجموعة Postman وضع مفتاح ah_test_ في المتغير apiKey.