สร้าง Webhook Secret

POSThttps://api.omise.co/webhooks/secrets

สร้าง webhook signing secret ใหม่สำหรับบัญชีของคุณ ค่า secret จะถูกส่งคืนเพียงครั้งเดียวตอนสร้าง - เก็บไว้อย่างปลอดภัยทันที ใช้ secret นี้เพื่อยืนยันว่าเหตุการณ์ webhook ที่เข้ามามาจาก Omise จริง

---

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

endpoint นี้ไม่ต้องการพารามิเตอร์คำขอใดๆ signing secret ใหม่จะถูกสร้างโดยอัตโนมัติ

ทางเลือก - 1 ฟิลด์พารามิเตอร์ทางเลือก

▼

---

การตอบกลับ

200

สร้าง Webhook secret สำเร็จ

สร้าง Webhook secret แล้ว ค่า secret จะรวมอยู่ในการตอบกลับนี้เท่านั้น - จะไม่สามารถดึงได้อีก เก็บไว้อย่างปลอดภัยทันที

รวมถึง:

• object - ประเภทอ็อบเจกต์ (เป็น "webhook_secret" เสมอ)
• id - ตัวระบุ secret เฉพาะ (whsec_*) เก็บไว้สำหรับการจัดการ
• secret - signing secret จริง เก็บทันที - จะไม่แสดงอีก
• livemode - เป็น secret โหมดจริงหรือไม่
• created_at - timestamp การสร้างในรูปแบบ ISO 8601
• metadata - ข้อมูลคีย์-ค่าที่กำหนดเอง (หากระบุ)

400

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

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

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

• Metadata เกิน 15,000 ตัวอักษร
• รูปแบบ metadata ไม่ถูกต้อง
• ถึงจำนวน secrets สูงสุดแล้ว

401

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

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

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

• ไม่มีส่วนหัว Authorization
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/webhooks/secrets \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -X POST

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

secret = Omise::WebhookSecret.create({
  metadata: {
    environment: 'production'
  }
})

# เก็บ secret.secret อย่างปลอดภัย - จะไม่แสดงอีก
puts secret.secret

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

secret = omise.WebhookSecret.create(
    metadata={
        'environment': 'production'
    }
)

# เก็บ secret.secret อย่างปลอดภัย - จะไม่แสดงอีก
print(secret.secret)

Node.js

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

const secret = await omise.webhookSecrets.create({
  metadata: {
    environment: 'production'
  }
});

// เก็บ secret.secret อย่างปลอดภัย - จะไม่แสดงอีก
console.log(secret.secret);

PHP

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

$secret = OmiseWebhookSecret::create([
    'metadata' => [
        'environment' => 'production'
    ]
]);

// เก็บ $secret['secret'] อย่างปลอดภัย - จะไม่แสดงอีก
echo $secret['secret'];

Java

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

WebhookSecret secret = client.webhookSecrets().create()
    .metadata("environment", "production")
    .send();

// เก็บ secret.getSecret() อย่างปลอดภัย - จะไม่แสดงอีก
System.out.println(secret.getSecret());

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var secret = await client.WebhookSecrets.Create(new CreateWebhookSecretRequest
{
    Metadata = new Dictionary<string, string>
    {
        { "environment", "production" }
    }
});

// เก็บ secret.Secret อย่างปลอดภัย - จะไม่แสดงอีก
Console.WriteLine(secret.Secret);

Go

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

secret, _ := client.WebhookSecrets().Create(&operations.CreateWebhookSecret{
    Metadata: map[string]string{
        "environment": "production",
    },
})

// เก็บ secret.Secret อย่างปลอดภัย - จะไม่แสดงอีก
fmt.Println(secret.Secret)

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

รหัส	คำอธิบาย	การแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบและขนาด metadata
limit_reached	ถึงจำนวน secrets สูงสุดแล้ว	ลบ secrets ที่ไม่ใช้ก่อนสร้างใหม่

ฟิลด์ Webhook Secret

ฟิลด์	คำอธิบาย
object	ประเภทอ็อบเจกต์ (เป็น "webhook_secret" เสมอ)
id	ตัวระบุ secret เฉพาะ (whsec_*)
secret	signing secret (แสดงเฉพาะตอนสร้าง)
livemode	เป็น secret โหมดจริงหรือไม่
created_at	timestamp การสร้างในรูปแบบ ISO 8601
metadata	ข้อมูลคีย์-ค่าที่กำหนดเอง

---

หมายเหตุสำคัญ

เก็บ Secret ทันที

ฟิลด์ secret จะถูกส่งคืนเพียงครั้งเดียวเมื่อ webhook secret ถูกสร้าง หลังจากการตอบกลับนี้ คุณจะสามารถดูได้เฉพาะ ID ของ secret วันที่สร้าง และ metadata - ไม่ใช่ค่า secret จริง

เก็บ secret ในสถานที่ปลอดภัย เช่น:

• ตัวแปรสภาพแวดล้อม
• AWS Secrets Manager
• HashiCorp Vault
• Google Cloud Secret Manager
• Azure Key Vault

การใช้หลาย Secrets

คุณสามารถมี webhook secrets ที่ใช้งานได้หลายอันพร้อมกัน สิ่งนี้มีประโยชน์ในระหว่างการหมุนเวียนคีย์:

1. สร้าง secret ใหม่
2. อัปเดตโค้ดยืนยันให้รับทั้ง secrets เก่าและใหม่
3. deploy โค้ดยืนยันที่อัปเดต
4. ลบ secret เก่า

---

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

▼

ลองใช้งาน

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

▼

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