สร้างกฎการกำหนดเส้นทาง

POSThttps://api.omise.co/routing_group_rules

สร้างกฎกลุ่มการกำหนดเส้นทางใหม่สำหรับการกำหนดเส้นทางการชำระเงิน กฎการกำหนดเส้นทางช่วยให้คุณควบคุมวิธีการประมวลผลธุรกรรมข้ามผู้ให้บริการชำระเงินและ acquirer ต่างๆ ตามเงื่อนไขต่างๆ

---

🔑ข้อมูลยืนยันตัวตน API

▼

---

พารามิเตอร์คำขอ

จำเป็น - 3 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`name`STRING(required)

ชื่อที่มนุษย์อ่านได้สำหรับกฎการกำหนดเส้นทาง ใช้สำหรับการระบุในแดชบอร์ดและ log

Example:"Route high-value cards to Provider A"

`conditions`ARRAY(required)

อาร์เรย์ของออบเจกต์เงื่อนไขที่กำหนดเมื่อไหร่กฎนี้จะใช้ แต่ละเงื่อนไขระบุฟิลด์ ตัวดำเนินการ และค่าที่จะจับคู่

Example:[{"field":"amount","operator":"gte","value":100000}]

`provider`STRING(required)

ตัวระบุผู้ให้บริการชำระเงินเป้าหมาย ธุรกรรมที่ตรงกับกฎนี้จะถูกกำหนดเส้นทางไปยังผู้ให้บริการนี้

Example:"provider_a"

โครงสร้างเงื่อนไขพารามิเตอร์เงื่อนไข

▼

`conditions[].field`STRING(required)

ฟิลด์ธุรกรรมที่จะประเมิน ตัวเลือกรวมถึง amount, currency, card_brand, card_type, card_country, ฟิลด์ metadata

Example:"amount"

Values:amount, currency, card_brand, card_type, card_country, metadata

`conditions[].operator`STRING(required)

ตัวดำเนินการเปรียบเทียบสำหรับเงื่อนไข

Example:"gte"

Values:eq, neq, gt, gte, lt, lte, in, not_in, contains

`conditions[].value`ANY(required)

ค่าที่จะเปรียบเทียบ ประเภทขึ้นอยู่กับฟิลด์ (ตัวเลขสำหรับ amount, สตริงสำหรับ currency, อาร์เรย์สำหรับตัวดำเนินการ "in")

Example:100000

เพิ่มเติม - 5 ฟิลด์พารามิเตอร์เพิ่มเติม

▼

Metadata - 1 ฟิลด์พารามิเตอร์ Metadata

▼

---

การตอบกลับ

200

สร้างกฎสำเร็จ

สร้างกฎการกำหนดเส้นทางสำเร็จ กฎจะเปิดใช้งานทันทีเว้นแต่ enabled จะถูกตั้งค่าเป็น false

Response รวมถึง:

• object - ส่งคืน "routing_group_rule" เสมอ
• id - ตัวระบุกฎเฉพาะ
• name - ชื่อกฎ
• conditions - อาร์เรย์ของออบเจกต์เงื่อนไข
• provider - ตัวระบุผู้ให้บริการเป้าหมาย
• priority - ลำดับความสำคัญของกฎ
• enabled - กฎเปิดใช้งานหรือไม่
• created_at - timestamp การสร้าง

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความ error สำหรับรายละเอียด

สาเหตุทั่วไป:

• ขาดฟิลด์ที่จำเป็น (name, conditions, provider)
• โครงสร้างเงื่อนไขไม่ถูกต้อง
• ตัวระบุผู้ให้บริการไม่รู้จัก
• ตัวดำเนินการไม่ถูกต้องสำหรับประเภทฟิลด์
• ประเภทค่าเงื่อนไขไม่ตรงกัน

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือขาดหายไป

สาเหตุทั่วไป:

• ขาด Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบทรัพยากรที่อ้างอิง

สาเหตุทั่วไป:

• ตัวระบุผู้ให้บริการไม่ถูกต้อง
• ฟีเจอร์ routing ไม่ได้เปิดใช้งานสำหรับบัญชี

5xx

เซิร์ฟเวอร์ error

เกิด error ฝั่งเซิร์ฟเวอร์ กรณีนี้พบได้น้อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการ Error สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/routing_group_rules \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "name=Route high-value to Provider A" \
  -d "provider=provider_a" \
  -d "conditions[0][field]=amount" \
  -d "conditions[0][operator]=gte" \
  -d "conditions[0][value]=100000" \
  -d "priority=100"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

rule = Omise::RoutingGroupRule.create({
  name: 'Route high-value to Provider A',
  provider: 'provider_a',
  conditions: [
    { field: 'amount', operator: 'gte', value: 100000 }
  ],
  priority: 100
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

rule = omise.RoutingGroupRule.create(
    name='Route high-value to Provider A',
    provider='provider_a',
    conditions=[
        {'field': 'amount', 'operator': 'gte', 'value': 100000}
    ],
    priority=100
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const rule = await omise.routingGroupRules.create({
  name: 'Route high-value to Provider A',
  provider: 'provider_a',
  conditions: [
    { field: 'amount', operator: 'gte', value: 100000 }
  ],
  priority: 100
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$rule = OmiseRoutingGroupRule::create([
    'name' => 'Route high-value to Provider A',
    'provider' => 'provider_a',
    'conditions' => [
        ['field' => 'amount', 'operator' => 'gte', 'value' => 100000]
    ],
    'priority' => 100
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Condition condition = new Condition.Builder()
    .field("amount")
    .operator("gte")
    .value(100000)
    .build();

RoutingGroupRule rule = client.routingGroupRules().create()
    .name("Route high-value to Provider A")
    .provider("provider_a")
    .conditions(Arrays.asList(condition))
    .priority(100)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var rule = await client.RoutingGroupRules.Create(new CreateRoutingRuleRequest
{
    Name = "Route high-value to Provider A",
    Provider = "provider_a",
    Conditions = new List<Condition>
    {
        new Condition { Field = "amount", Operator = "gte", Value = 100000 }
    },
    Priority = 100
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

rule, _ := client.RoutingGroupRules().Create(&operations.CreateRoutingGroupRule{
    Name:     "Route high-value to Provider A",
    Provider: "provider_a",
    Conditions: []omise.Condition{
        {Field: "amount", Operator: "gte", Value: 100000},
    },
    Priority: 100,
})

---

รหัส Error และผลลัพธ์

รหัส Error ทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบว่าฟิลด์ที่จำเป็นทั้งหมดถูกระบุ
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_condition	โครงสร้างเงื่อนไขไม่ถูกต้อง	ตรวจสอบว่า field, operator และ value ถูกต้อง
invalid_provider	ไม่พบผู้ให้บริการ	ตรวจสอบว่าตัวระบุผู้ให้บริการมีอยู่
duplicate_rule	มีกฎชื่อเดียวกันอยู่แล้ว	ใช้ชื่อกฎที่ไม่ซ้ำ

ตัวดำเนินการเงื่อนไข

ตัวดำเนินการ	คำอธิบาย	ใช้ได้กับ
eq	เท่ากับ	ทุกฟิลด์
neq	ไม่เท่ากับ	ทุกฟิลด์
gt	มากกว่า	amount
gte	มากกว่าหรือเท่ากับ	amount
lt	น้อยกว่า	amount
lte	น้อยกว่าหรือเท่ากับ	amount
in	ค่าในรายการ	currency, card_brand, card_type
not_in	ค่าไม่อยู่ในรายการ	currency, card_brand, card_type
contains	มีสตริงย่อย	ฟิลด์ metadata

ฟิลด์ออบเจกต์กฎการกำหนดเส้นทาง

ฟิลด์	ประเภท	คำอธิบาย
object	string	ส่งคืน "routing_group_rule" เสมอ
id	string	ตัวระบุกฎเฉพาะ
name	string	ชื่อกฎที่มนุษย์อ่านได้
description	string	คำอธิบายกฎ
conditions	array	อาร์เรย์ของออบเจกต์เงื่อนไข
provider	string	ตัวระบุผู้ให้บริการเป้าหมาย
priority	integer	ลำดับความสำคัญในการประเมินกฎ
match_type	string	ตรรกะการจับคู่เงื่อนไข (all/any)
weight	integer	น้ำหนักสำหรับการกระจายโหลด
enabled	boolean	กฎเปิดใช้งานหรือไม่
metadata	object	คู่คีย์-ค่าแบบกำหนดเอง
created_at	string	timestamp การสร้าง (ISO 8601)
updated_at	string	timestamp การอัปเดตล่าสุด (ISO 8601)

---

ลองใช้งาน

จำเป็น - 3 ฟิลด์

▼

name(จำเป็น)

provider(จำเป็น)

conditions(จำเป็น)

เพิ่มเติม - 6 ฟิลด์

▼

IP ของคุณ: ...กำลังโหลด...