Ana məzmuna keçin

API düyünü

Bu düyün müxtəlif API-lərlə qarşılıqlı əlaqə yaratmağa imkan verir ki, bu da xarici xidmətlərlə inteqrasiya üçün faydalıdır.

API düyününün parametrləri​

IMG2

1. Ad​

Düyünün adını göstərmək üçün sahə.
Ad iş sahəsində görünür və düyünü asanlıqla tanımağa kömək edir.
Boş qoyulsa, düyün API adlanacaq.

Nümunə:

  • Düyünün adı: Ödəniş Sessiyası Yarat

2. Metod​

Burada sorğu göndərmək üçün istifadə olunacaq API metodu seçilir. Mövcud metodlar:

  • "Ödəniş Sessiyası Yarat":
    Yeni bir ödəniş sessiyası yaradır.

  • "Ödəniş Sessiyasını Yenilə":
    Mövcud ödəniş sessiyasını yeniləyir.

  • "ID ilə Ödəniş Sessiyasını Al":
    Unikal sessiya identifikatoruna əsasən ödəniş sessiyası haqqında məlumat alır.

  • "Order ID ilə Ödəniş Sessiyasını Al":
    Sifariş identifikatorunu istifadə edərək ödəniş sessiyası haqqında məlumat alır.

Nümunə:

  • Metod: Ödəniş Sessiyası Yarat

3. Məlumat​

Bu sahə JSON formatında sorğu məlumatlarını formalaşdırmaq üçün Mustache şablonundan istifadə edir.
Şablona dəyərləri yerinə yetirmək üçün msg mesajından məlumatlardan istifadə edə bilərsiniz.

Şablon nümunəsi ( "Ödəniş Sessiyası Yarat" metodu üçün):

 {
   "orderId": {{orderId}},
   "type": "session"
 }

Bu nümunədə orderId dəyəri msg mesajından yerinə yetiriləcək.

Şablon nümunəsi ( "Ödəniş Sessiyasını Yenilə" metodu üçün):

 {
   "id": {{paymentSessionId}},
   "paymentUrl": "{{{payload.links.1.href}}}"
 }

Mustache şablonlarından istifadə edərək API ilə qarşılıqlı əlaqə üçün lazım olan mürəkkəb məlumatları və parametrləri ötürə bilərsiniz.

Sorğu nümunələri​

Nümunə 1: Ödəniş sessiyasının yaradılması​

Düyün parametrləri:

  • Metod: Ödəniş Sessiyası Yarat
  • Məlumat: 
    {
      "orderId": {{orderId}},
      "type": "session"
    }

Mesaj:

{
  "orderId": 123
}

Nəticə:
Düyün mesajdakı məlumatlarla ödəniş sessiyasını yaratmaq üçün sorğu göndərəcək. Nəticədə yeni ödəniş sessiyası haqqında məlumat alınacaq.

Nümunə 2: Ödəniş sessiyasının yenilənməsi​

Düyün parametrləri:

  • Metod: Ödəniş Sessiyasını Yenilə
  • Məlumat: 
    {
      "id": {{paymentSessionId}},
      "paymentUrl": "{{{payload.links.1.href}}}"
    }

Mesaj:

{
  "paymentSessionId": 123,
  "payload": {
    "id": "8YP51523N05861826",
    ....
    "links": [
      {
        "href": "https://api.sandbox.paypal.com/v2/checkout/orders/8YP51523N05861826",
        "rel": "self",
        "method": "GET"
      },
      {
        "href": "https://www.sandbox.paypal.com/checkoutnow?token=8YP51523N05861826",
        "rel": "payer-action",
        "method": "GET"
      }
    ]
  }
}

Nəticə:
Düyün təqdim olunan payment_session_id və status dəyərlərini istifadə edərək ödəniş sessiyasının statusunu yeniləmək üçün sorğu göndərəcək.

Nümunə 3: ID ilə ödəniş sessiyasının alınması​

Düyün parametrləri:

  • Metod: ID ilə Ödəniş Sessiyasını Al
  • Məlumat: 
    {
      "id": "{{paymentSessionId}}"
    }

Mesaj:

{
  "paymentSessionId": 123
}

Nəticə:
Düyün unikal sessiya identifikatoruna əsaslanaraq ödəniş sessiyası haqqında məlumat almaq üçün sorğu göndərəcək.

Nümunə 4: Order ID ilə ödəniş sessiyasının alınması​

Düyün parametrləri:

  • Metod: Order ID ilə Ödəniş Sessiyasını Al
  • Məlumat: 
    {
      "orderId": "{{payload.id}}"
    }

Mesaj:

{
  "payload": {
    "id": 1
  }
}

Nəticə:
Düyün göstərilən sifariş identifikatoru ilə bağlı ödəniş sessiyası haqqında məlumat almaq üçün sorğu göndərəcək.