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ı, 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 yöntemini seçin. Mevcut yöntemler:

  • "Sayfa nesnesini güncelle" — Sayfa nesnesinin güncellenmesi
  • "Seçilen kategori için sayfa ürünlerinde sayfalama ile tüm nesneleri ara" — Sayfalama ile ürün arama
  • "Ürün sayfasının durumunu değiştirme" — Ürün sayfasının durumunu değiştirme
  • "Ürün sayfası güncelleme" — Ürün sayfasının güncellenmesi
  • "Kullanıcı nesnesini güncelle - yönetici" — Kullanıcı nesnesinin güncellenmesi (yönetici tarafından)
  • "Bir kullanıcı nesnesini güncelle" — Bir kullanıcı nesnesinin güncellenmesi
  • "Bir varlık niteliğinin değerini güncelleme" — Varlık niteliğinin değerinin güncellenmesi
  • "Sipariş depolama nesnesine ait tüm siparişleri alma" — Depoya ait tüm siparişleri alma
  • "Sipariş depolama nesnesine ait bir siparişin durumunu güncelleme" — Siparişin durumunu güncelleme
  • "Ödeme oturumu güncelleme" — Ödeme oturumunun güncellenmesi
  • "Kimliğine göre bir ödeme oturumu nesnesini alma" — ID ile ödeme oturumu alma
  • "Ödeme oturumu oluşturma" — Ödeme oturumu oluşturma
  • "Koleksiyona ait tüm kayıtları alma" — Koleksiyona ait kayıtları alma
  • "Koleksiyonda bir kayıt oluşturma" — Koleksiyonda bir kayıt oluşturma
  • "Koleksiyondaki bir kaydı değiştirme" — Koleksiyondaki bir kaydı değiştirme
  • "Koleksiyon kaydından bir nesneyi silme" — Koleksiyon kaydından bir nesneyi silme

3. Sorgu parametreleri​

URL isteği parametreleri. 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" yöntemi için):

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

4. İstek gövdesi​

JSON formatında istek gövdesi. msg içindeki verilerin yerleştirilmesi için Mustache'ı destekler.

Örnek ( "Ödeme oturumu oluşturma" yöntemi 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 veri 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ı Swagger'da tanımlanmışsa, yanlarında metin açıklamaları görüntülenir. Bu açıklamalar, Mustache şablonları yazarken kod editörü (Monaco) 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.

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 iletir.
  • Eğer yolda herhangi bir function düğümü verileri daha ileriye iletmiyorsa, ancak Çıktı Örneği (JSON) alanı doldurulmuşsa, bu veriler sahte veriler 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 Swagger'dan gelen bir yanıt şemasına sahiptir. Çalıştır butonuna basıldığında, şema API'den gelen gerçek yanıtla yeniden yazılır. Bu durumda, Swagger açıklamasıyla örtüşen alanlar, metin açıklamalarını korur.

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

Sadece okuma (GET) istekleri yapan 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: Koleksiyona ait tüm kayıtları alma
  • Sorgu parametreleri: 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "en_US",
      "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.