مقدمة
يصف هذا القسم AurTap واجهة برمجة تطبيقات بوابة الدفع.
AurTap من السهل تنفيذ واجهة برمجة التطبيقات (API) في برامج عملك. واجهة برمجة التطبيقات لدينا ذات عناوين URL منسّقة جيدًا، وتقبل طلبات cURL، وتُرجع استجابات JSON.
يمكنك استخدام واجهة برمجة التطبيقات (API) في وضع الاختبار، وهو ما لا يؤثر على بياناتك المباشرة. يُستخدم مفتاح API لمصادقة الطلب وتحديد ما إذا كان الطلب دفعة صالحة أم لا. لوضع الاختبار استخدم عنوان URL الخاص بالبيئة التجريبية، وفي حالة الوضع المباشر استخدم عنوان URL المباشر من قسم الشروع في الدفع .
العملات المدعومة
يصف هذا القسم العملات التي يدعمها AurTap
AurTap يسمح بإجراء المعاملات بالعملات أدناه. قد تتم إضافة أي عملة جديدة في المستقبل.
| اسم العملة | رمز العملة | رمز العملة |
|---|---|---|
| United States Dollar | $ | USD |
| syr | syr | SYR |
احصل على مفتاح API
يصف هذا القسم كيف يمكنك الحصول على مفتاح API الخاص بك.
سجّل الدخول إلى AurTap حساب التاجر. إذا لم يكن لديك أي حساب؟ انقر هنا
الخطوة التالية هي العثور على مفتاح واجهة برمجة التطبيقات القائمة في الشريط الجانبي للوحة التحكم. انقر على القائمة.
يمكن العثور على مفاتيح API هناك المفتاح العام والمفتاح السري. استخدم هذه المفاتيح لبدء طلب API. يمكنك في كل مرة إنشاء مفتاح API جديد بالنقر على إنشاء مفتاح API زر. تذكّر ألا تشارك هذه المفاتيح مع أي شخص.
الشروع في الدفع
يصف هذا القسم عملية بدء الدفع.
لبدء الدفع، اتبع الكود المثال وكن حذرًا مع المعاملات (parameters). ستحتاج إلى إرسال الطلب إلى نقاط نهاية API التالية.
نقطة النهاية المباشرة: https://aurtap.com/payment/initiate
نقطة نهاية الاختبار: https://aurtap.com/sandbox/payment/initiate
بريد وضع الاختبار: test_mode@mail.com
رمز التحقق من وضع الاختبار: 222666
طريقة الطلب: POST
اطلب الوصول إلى نقطة النهاية باستخدام المعلمات التالية أدناه.
| اسم المعامل | نوع المعامل | وصف |
|---|---|---|
| public_key | string (50) | مطلوب مفتاح API العام الخاص بك |
| identifier | string (20) | مطلوب المعرف هو في الأساس لتحديد الدفع في نهايتك |
| currency | string (4) | مطلوب رمز العملة، يجب أن يكون بأحرف كبيرة. مثال: USD، EUR |
| amount | decimal | مطلوب مبلغ الدفع. |
| details | string (100) | مطلوب تفاصيل الدفع أو المعاملة الخاصة بك. |
| ipn_url | string | مطلوب عنوان URL لإشعار الدفع الفوري. |
| success_url | string | مطلوب عنوان URL لإعادة توجيه نجاح الدفع. |
| cancel_url | string | مطلوب عنوان URL لإعادة توجيه إلغاء الدفع. |
| site_logo | string/url | مطلوب شعار موقع عملك. |
| checkout_theme | string | خياري سمة نموذج الدفع: داكن/فاتح. السمة الافتراضية هي الفاتحة |
| customer_name | string (30) | مطلوب اسم العميل. |
| customer_email | string (30) | مطلوب البريد الإلكتروني الصحيح للعميل. |
<?php
$parameters = [
'identifier' => 'DFU80XZIKS',
'currency' => 'USD',
'amount' => 100.00,
'details' => 'Purchase T-shirt',
'ipn_url' => 'http://example.com/ipn_url.php',
'cancel_url' => 'http://example.com/cancel_url.php',
'success_url' => 'http://example.com/success_url.php',
'public_key' => 'your_public_key',
'site_logo' => 'https://aurtap.com/assets/images/logoIcon/logo.png',
'checkout_theme' => 'dark',
'customer_name' => 'John Doe',
'customer_email' => 'john@mail.com',
];
//live end point
$url = "https://aurtap.com/payment/initiate";
//test end point
$url = "https://aurtap.com/sandbox/payment/initiate";
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
//$result contains the response back.
?>//Error Response.
{
"error": "true",
"message": "Invalid api key"
}
//Success Response.
{
"success": "ok",
"message": "Payment Initiated. Redirect to url.",
"url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}
التحقق من صحة الدفع وIPN
يصف هذا القسم عملية الحصول على إشعار الدفع الفوري.
لبدء الدفع، اتبع الكود المثال وكن حذرًا مع المعاملات (parameters). ستحتاج إلى إرسال الطلب إلى نقاط نهاية API التالية.
نقطة النهاية: عنوان URL لتطبيق عملك.
طريقة الطلب: POST
سوف تحصل على المعلمات التالية أدناه.
| اسم المعامل | وصف |
|---|---|
| status | حالة نجاح الدفع. |
| identifier | المعرف هو في الأساس لتحديد الدفع في نهايتك. |
| signature | توقيع التجزئة للتحقق من الدفع الخاص بك في نهايتك. |
| data | تحتوي البيانات على بعض المعلومات الأساسية مثل الرسوم والمبلغ والعملة ومعرف معاملة الدفع وما إلى ذلك. |
<?php
//Receive the response parameter
$status = $_POST['status'];
$signature = $_POST['signature'];
$identifier = $_POST['identifier'];
$data = $_POST['data'];
// Generate your signature
$customKey = $data['amount'].$identifier;
$secret = 'YOUR_SECRET_KEY';
$mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));
$myIdentifier = 'YOUR_GIVEN_IDENTIFIER';
if($status == "success" && $signature == $mySignature && $identifier == $myIdentifier){
//your operation logic
}
?>