Lewati ke konten utama

Node admin-api

Node admin-api memberikan akses langsung ke API internal OneEntry. Ini memungkinkan Anda untuk membaca dan memodifikasi pesanan, halaman, pengguna, koleksi, dan sesi pembayaran langsung dari alur integrasi—tanpa perlu menulis permintaan HTTP secara manual.

Pengaturan untuk node admin-api​

IMG2

1. Nama​

Sebuah kolom untuk menentukan nama node.
Nama ditampilkan di ruang kerja dan membantu mengidentifikasi node dengan mudah.
Jika dibiarkan kosong, node akan disebut admin-api.

Contoh:

  • Nama node: Buat Sesi Pembayaran

2. Tipe​

Pilihan metode API yang akan dipanggil ketika sebuah pesan melewati node. Metode yang tersedia:

  • "Perbarui objek halaman" — Perbarui objek halaman
  • "Cari semua objek di halaman produk dengan paginasi untuk kategori yang dipilih" — Cari produk dengan paginasi
  • "Mengubah status halaman produk" — Ubah status halaman produk
  • "Perbarui halaman produk" — Perbarui halaman produk
  • "Perbarui objek pengguna - admin" — Perbarui objek pengguna (oleh admin)
  • "Perbarui satu objek pengguna" — Perbarui satu objek pengguna
  • "Memperbarui nilai atribut entitas" — Perbarui nilai atribut entitas
  • "Menerima semua pesanan yang menjadi milik objek penyimpanan pesanan" — Ambil semua pesanan dari penyimpanan
  • "Memperbarui status pesanan yang menjadi milik objek penyimpanan pesanan" — Perbarui status pesanan
  • "Perbarui sesi pembayaran" — Perbarui sesi pembayaran
  • "Menerima satu objek sesi pembayaran berdasarkan identifikatornya" — Ambil sesi pembayaran berdasarkan ID
  • "Membuat sesi pembayaran" — Buat sesi pembayaran
  • "Menerima semua catatan yang menjadi milik koleksi" — Ambil catatan koleksi
  • "Membuat catatan dalam koleksi" — Buat catatan dalam koleksi
  • "Mengubah catatan dalam koleksi" — Modifikasi catatan dalam koleksi
  • "Menghapus objek dari catatan koleksi" — Hapus objek dari catatan koleksi

3. Parameter kueri​

Parameter permintaan URL. Kolom ini menggunakan sintaks Mustache—nilai dari msg dapat disisipkan menggunakan {{variable}}.

Contoh (untuk metode "Menerima semua catatan yang menjadi milik koleksi"):

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

4. Badan permintaan​

Badan permintaan dalam format JSON. Mendukung Mustache untuk substitusi data dari msg.

Contoh (untuk metode "Membuat sesi pembayaran"):

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

5. Skema Input​

Blok Skema Input ditampilkan di pengaturan node dan menunjukkan struktur data yang berasal dari node sebelumnya dalam alur. Skema disajikan sebagai pasangan "kunci - tipe," dengan mempertimbangkan pengelompokan objek.

Jika bidang skema dijelaskan dalam Swagger, deskripsi tekstual ditampilkan di sampingnya. Deskripsi ini juga diambil oleh editor kode (Monaco) sebagai petunjuk saat menulis template Mustache.

Contoh tampilan Skema Input:

payload
  └── order
        ├── id           (integer)  — Identifikator pesanan
        ├── status       (string)   — Status saat ini
        └── totalPrice   (number)   — Jumlah total

6. Tombol Eksekusi​

Tombol Eksekusi memungkinkan Anda untuk memanggil permintaan API langsung dari formulir pengeditan node tanpa menjalankan seluruh alur.

Cara kerjanya:

  • Server mengeksekusi seluruh alur dari awal hingga node ini, meneruskan data sepanjang rantai sesuai dengan status terakhir yang diterbitkan dari alur.
  • Jika ada node function di sepanjang jalan yang tidak meneruskan data lebih lanjut tetapi memiliki kolom Contoh Output (JSON) yang terisi, data tersebut digunakan sebagai data tiruan.
  • Dalam kasus respons yang berhasil, respons API diteruskan ke node berikutnya sebagai skema.
  • Jika permintaan mengembalikan kesalahan, skema tidak diteruskan ke node berikutnya.
info

Sebelum menggunakan tombol Eksekusi, pastikan bahwa alur telah diterbitkan. Server mengeksekusi rantai berdasarkan status publish terakhir.

Dampak pada skema:

Node admin-api pada awalnya memiliki skema respons dari Swagger. Ketika tombol Eksekusi ditekan, skema akan ditimpa dengan respons aktual dari API. Bidang yang cocok dengan deskripsi Swagger mempertahankan deskripsi tekstualnya.

7. Pemanggilan otomatis permintaan hanya-baca​

Semua node admin-api yang melakukan permintaan hanya-baca (GET) dipanggil secara otomatis:

  • ketika halaman Integrasi dibuka,
  • ketika alur diperbarui melalui tombol Publikasikan.

Ini memastikan bahwa skema data di node berikutnya selalu diperbarui tanpa pemicu manual.

Contoh Penggunaan​

Contoh 1: Membuat sesi pembayaran​

Pengaturan node:

  • Tipe: Membuat sesi pembayaran
  • Badan permintaan: 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Hasil:
Node membuat sesi pembayaran menggunakan orderId dari pesan yang masuk dan meneruskan data sesi baru ke node berikutnya.

Contoh 2: Memperbarui status pesanan​

Pengaturan node:

  • Tipe: Memperbarui status pesanan yang menjadi milik objek penyimpanan pesanan
  • Parameter kueri: 
    {
      "id": {{orderId}}
    }
  • Badan permintaan: 
    {
      "status": "{{newStatus}}"
    }

Hasil:
Node memperbarui status pesanan menggunakan data dari pesan yang masuk.

Contoh 3: Mengambil catatan koleksi​

Pengaturan node:

  • Tipe: Menerima semua catatan yang menjadi milik koleksi
  • Parameter kueri: 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "en_US",
      "offset": 0,
      "limit": 10
    }

Hasil:
Node mengembalikan daftar catatan koleksi. Karena ini adalah permintaan hanya-baca, skema respons secara otomatis dimuat saat halaman dibuka.