Ana içeriğe geç

admin-api Düğümü

admin-api düğümü, OneEntry'nin iç API'sine doğrudan erişim sağlar. Bu sayede, HTTP istekleri yazmadan, entegrasyon akışından siparişleri, sayfaları, ürünleri, kullanıcıları, koleksiyonları ve ödeme oturumlarını okuyup değiştirebilirsiniz.

admin-api Düğüm Ayarları​

IMG2

1. İsim​

Düğümün adını belirtmek için bir alan.
İsim, çalışma alanında görüntülenir ve düğümü kolayca tanımlamaya yardımcı olur.
Boş bırakılırsa, düğüm admin-api olarak adlandırılacaktır.

Örnek:

  • Düğüm adı: Ödeme Oturumu Oluştur

2. Tür​

Mesajın düğümden geçerken çağrılacak API işlemini seçme. Bu, API bölümlerine göre gruplandırılmış işlemlerin isimlerinin arayüz dilindeki API açıklamasından alındığı bir açılır liste. Bu dile çeviri yoksa, isimler orijinal dilde gösterilir.

İşlem seti OneEntry sürümüne bağlıdır, bu nedenle kesin listeyi Tür açılır listesinden kontrol edin. İşlemler şunları kapsar:

  • sayfalar ve ürünler — örneğin, "Sayfa nesnesi güncelleme", "Sayfa nesnelerini sayfalama ve filtrelerle arama.", kimliklere göre birden fazla ürün alma;
  • kullanıcılar — kullanıcıları arama dahil;
  • öznitelik değerleri — birden fazla varlığın öznitelik değerlerini güncelleme dahil;
  • siparişler — sipariş durumunu değiştirme, durum tetikleyicisi uygulama, iadeler;
  • ödeme oturumları — örneğin, "Ödeme oturumu oluşturma" ve "Ödeme oturumu güncelleme";
  • bonus bakiyesi — kullanıcı bakiyesini manuel olarak ayarlama;
  • koleksiyon kayıtları — örneğin, "Bir koleksiyona ait tüm kayıtları alma.".

İşlem seçildikten sonra Sorgu parametreleri ve İstek gövdesi alanları API açıklamasından bir örnekle doldurulur — kendi değerlerinizi yerleştirmeniz yeterlidir.

3. Sorgu parametreleri​

Sorgu parametreleri. Düğüm, seçilen işlemden yolu ve HTTP yöntemini otomatik olarak alır, formlarda düzenlenemez. Yol parametrelerinin değerleri (örneğin, kayıt kimliği) bu alanda URL sorgu parametreleriyle birlikte belirtilir.

Alan, Mustache sözdizimini kullanır — msg içindeki değerler {{değişken}} ile yerleştirilebilir.

Örnek (koleksiyona ait tüm kayıtları alma işlemi için):

{
  "entityType": "orders",
  "entityId": "{{orderId}}",
  "langCode": "tr_TR",
  "offset": 0,
  "limit": 1,
  "marker": "delivery"
}

4. İstek gövdesi​

JSON formatında istek gövdesi. Alan, yalnızca POST, PUT ve PATCH yöntemleriyle işlemler için görüntülenir. msg içindeki verilerin yerleştirilmesi için Mustache'ı destekler.

Örnek (ödeme oturumu oluşturma işlemi için):

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

5. Girdi Şeması​

Girdi Şeması bloğu, düğüm ayarlarında görüntülenir ve akıştaki bir önceki düğümden gelen verilerin yapısını gösterir. Şema, "anahtar - tür" çiftleri şeklinde, nesnelerin iç içe geçmişliğini dikkate alarak sunulur.

Eğer şema alanları API açıklamasında varsa, yanlarında metin açıklamaları görüntülenir. Bu açıklamalar, Mustache şablonları yazarken kod editörü tarafından ipuçları olarak alınır.

Girdi Şemasının görüntülenme örneği:

payload
  └── order
        ├── id           (integer)  — Sipariş kimliği
        ├── status       (string)   — Mevcut durum
        └── totalPrice   (number)   — Toplam tutar

6. Çalıştır Butonu​

Çalıştır butonu, akışın tamamını başlatmadan düğüm düzenleme formundan API isteğini çağırmanıza olanak tanır.

Bu nasıl çalışır:

  • Sunucu, akışın başından bu düğüme kadar tüm akışı gerçekleştirir ve verileri son yayımlanan akış durumuna göre zincir boyunca iletir.
  • Eğer yol üzerindeki herhangi bir function düğümü verileri daha ileriye iletmiyorsa, ancak Çıktı Örneği (JSON) alanı doldurulmuşsa, bu veriler test verisi olarak kullanılır.
  • Başarılı bir yanıt durumunda, API yanıtı bir sonraki düğüme şema olarak iletilir.
  • Eğer istek bir hata dönerse — şema bir sonraki düğüme iletilmez.
bilgi

Çalıştır butonunu kullanmadan önce akışın yayımlandığından emin olun. Sunucu, son publish durumuna göre zinciri gerçekleştirir.

Şemaya etkisi:

admin-api düğümü başlangıçta API açıklamasından gelen bir yanıt şemasına sahiptir. Çalıştır butonuna basıldığında, şema API'den gelen gerçek yanıtla üzerine yazılır. Bu durumda, API açıklamasıyla örtüşen alanlar metin açıklamalarını korur.

7. Salt okunur isteklerin otomatik çağrısı​

Salt okunur (GET) istekleri gerçekleştiren tüm admin-api düğümleri otomatik olarak çağrılır:

  • Entegrasyonlar sayfası açıldığında,
  • Yayınla butonuyla akış güncellendiğinde.

Bu, manuel başlatma olmadan bir sonraki düğümde her zaman güncel veri şemasına sahip olmanızı sağlar.

Kullanım Örnekleri​

Örnek 1: Ödeme oturumu oluşturma​

Düğüm ayarları:

  • Tür: Ödeme oturumu oluşturma
  • İstek gövdesi: 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Sonuç:
Düğüm, gelen mesajdan orderId kullanarak bir ödeme oturumu oluşturur ve yeni oturumun verilerini bir sonraki düğüme iletir.

Örnek 2: Sipariş durumunu güncelleme​

Düğüm ayarları:

  • Tür: Sipariş depolama nesnesine ait bir siparişin durumunu güncelleme
  • Sorgu parametreleri: 
    {
      "id": {{orderId}}
    }
  • İstek gövdesi: 
    {
      "status": "{{newStatus}}"
    }

Sonuç:
Düğüm, gelen mesajdan verileri kullanarak siparişin durumunu günceller.

Örnek 3: Koleksiyon kayıtlarını alma​

Düğüm ayarları:

  • Tür: Bir koleksiyona ait tüm kayıtları alma.
  • Sorgu parametreleri: 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "tr_TR",
      "offset": 0,
      "limit": 10
    }

Sonuç:
Düğüm, koleksiyon kayıtlarının bir listesini döndürür. Bu bir salt okunur istek olduğundan, sayfa açıldığında yanıt şeması otomatik olarak yüklenir.