Developer - Api Documentation

مقدمة

يصف هذا القسم Syrian Crypto واجهة برمجة تطبيقات بوابة الدفع.

Syrian Crypto من السهل تنفيذ API في برنامج عملك. تستخدم واجهتنا عناوين URL منظمة جيدًا، وتدعم طلبات cURL، وتعيد استجابات JSON.

يمكنك استخدام API في وضع الاختبار، مما لا يؤثر على بياناتك الحقيقية. يُستخدم مفتاح API للمصادقة على الطلب وتحديد ما إذا كان الدفع صحيحًا أم لا. لاختبار الوضع، استخدم عنوان URL التجريبي، وفي الوضع الحقيقي استخدم عنوان URL المباشر من القسم. بدء الدفع .

العملات المدعومة

يصف هذا القسم العملات المدعومة من Syrian Crypto

Syrian Crypto allows to make transaction with below currencies. Any new currency may update in future.

اسم العملة رمز العملة رمز العملة
United States Dollar $ USD
تيثر ₮ USDT

الحصول على مفتاح API

يصف هذا القسم كيفية الحصول على مفتاح API الخاص بك.

قم بتسجيل الدخول إلى Syrian Crypto حساب التاجر. If you don't have any ? اضغط هنا

الخطوة التالية هي العثور على مفتاح API في قائمة لوحة التحكم الجانبية. اضغط على القائمة.

يمكن العثور على مفاتيح API هناك وهي المفتاح العام والمفتاح السري. استخدم هذه المفاتيح لبدء طلب API. يمكنك توليد مفتاح API جديد في أي وقت بالضغط على توليد مفتاح API زر. تذكر عدم مشاركة هذه المفاتيح مع أي شخص.

بدء الدفع

يصف هذا القسم عملية بدء الدفع.

لبدء الدفع، اتبع نموذج الكود وكن حذرًا مع المعلمات. ستحتاج إلى إرسال طلب باستخدام نقاط نهاية API التالية.

نقطة النهاية الحية: https://syriancrypto.com/payment/initiate

نقطة النهاية التجريبية: https://syriancrypto.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
<?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://syriancrypto.com/assets/images/logoIcon/logo.png',
        'checkout_theme' => 'dark',
        'customer_name' => 'John Doe',
        'customer_email' => 'john@mail.com',

    ];

    //live end point
    $url = "https://syriancrypto.com/payment/initiate";

    //test end point
    $url = "https://syriancrypto.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"
}

التحقق من الدفع والإشعارات الفورية

يصف هذا القسم كيفية تلقي الإشعارات الفورية للدفع.

لبدء الدفع، اتبع نموذج الكود وكن حذرًا مع المعلمات. ستحتاج إلى إرسال طلب باستخدام نقاط نهاية API التالية.

نقطة النهاية: عنوان URL لنظام الإشعارات الفورية في تطبيق عملك.

طريقة الطلب: POST

ستتلقى المعلمات التالية:

اسم المعلمة الوصف
status حالة نجاح الدفع.
identifier المعرّف يُستخدم لتحديد الدفع في نظامك.
signature توقيع تجزئة للتحقق من الدفع في نظامك.
data تتضمن البيانات بعض المعلومات الأساسية مثل الرسوم، المبلغ، العملة، معرف المعاملة، إلخ.
مثال كود PHP
<?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
    }
?>