ค้นหา Audits

GEThttps://api.omise.co/audits/search

ค้นหาบันทึก audit สำหรับกิจกรรมบัญชี ใช้ endpoint นี้เพื่อค้นหาและกรองบันทึก audit ตามผู้ดำเนินการ ประเภทการดำเนินการ ทรัพยากร และช่วงเวลา บันทึก audit ให้ร่องรอยที่ครอบคลุมของการดำเนินการทั้งหมดที่ทำบนบัญชีของคุณ

---

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

จำเป็น - 1 รายการพารามิเตอร์ที่จำเป็น

▼

`scope`STRING(required)

ประเภทข้อมูลที่จะค้นหา ต้องตั้งเป็น "audit" สำหรับการค้นหาบันทึก audit

Example:"audit"

Default:"audit"

แนะนำ - 2 รายการพารามิเตอร์ที่แนะนำ

▼

`query`STRING(optional)

ข้อความค้นหาสำหรับการค้นหาแบบ full-text ค้นหาในคำอธิบาย audit ข้อมูลผู้ดำเนินการ และตัวระบุทรัพยากร

Example:"routing_group"

`filters`OBJECT(optional)

ตัวกรองการค้นหาเพื่อจำกัดผลลัพธ์ ตัวกรองที่ใช้ได้รวมถึงวันที่สร้าง อีเมลผู้ดำเนินการ ประเภทผู้ดำเนินการ ประเภท auditable UID ของ auditable และ verb

Example:{"created":"2024/01/01..2024/12/31","actor_email":["admin@example.com"]}

ตัวเลือกตัวกรอง - 6 รายการคุณสมบัติตัวกรอง

▼

`filters[created]`DATE-TIME(optional)

กรองตามวันที่สร้าง รองรับช่วงวันที่โดยใช้รูปแบบ: YYYY/MM/DD..YYYY/MM/DD

Example:"2024/01/01..2024/12/31"

`filters[actor_email]`ARRAY(optional)

กรองตามที่อยู่อีเมลผู้ดำเนินการ รับอาร์เรย์ของสตริงอีเมลเพื่อจับคู่กับผู้ใช้ที่ทำการดำเนินการ

Example:["admin@example.com","user@example.com"]

`filters[actor_type]`STRING(optional)

กรองตามประเภทผู้ดำเนินการ ระบุประเภทของเอนทิตีที่ทำการดำเนินการ

Example:"user"

Values:user

`filters[auditable_type]`STRING(optional)

กรองตามประเภททรัพยากร auditable ระบุประเภทของทรัพยากรที่ได้รับผลกระทบจากการดำเนินการ

Example:"routing_group"

Values:routing_group

`filters[auditable_uid]`STRING(optional)

กรองตามตัวระบุเฉพาะของทรัพยากรที่ถูก audit

Example:"rgrp_test_5xuy4w91xqz7d1w9u0t"

`filters[verb]`STRING(optional)

กรองตาม action verb ระบุประเภทของการดำเนินการที่ทำ

Example:"rules_switched"

Values:rules_switched

การแบ่งหน้า - 2 รายการพารามิเตอร์การแบ่งหน้า

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

ส่งคืน search object ที่มีผลลัพธ์บันทึก audit แบบแบ่งหน้าในอาร์เรย์ data

โครงสร้าง Response:

• object - ค่าสตริง "search"
• data - อาร์เรย์ของ audit objects ที่ตรงกับ query
• page - หมายเลขหน้าปัจจุบัน
• per_page - จำนวนรายการต่อหน้า
• total - จำนวนรายการทั้งหมดที่ตรงกับ query
• total_pages - จำนวนหน้าทั้งหมด
• filters - ตัวกรองการค้นหาที่ใช้
• query - Search query ที่ใช้
• scope - ประเภททรัพยากรที่ค้นหา (audit)
• location - เส้นทาง API endpoint

โครงสร้าง Audit object:

• object - ค่าสตริง "audit"
• id - ตัวระบุบันทึก audit เฉพาะ
• actor_email - อีเมลของผู้ใช้ที่ทำการดำเนินการ
• actor_type - ประเภทของผู้ดำเนินการ (เช่น user)
• auditable_type - ประเภทของทรัพยากรที่ได้รับผลกระทบ
• auditable_uid - ID เฉพาะของทรัพยากรที่ได้รับผลกระทบ
• verb - การดำเนินการที่ทำ
• created_at - Timestamp ของการดำเนินการ

400

Bad request

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

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

• ขาดพารามิเตอร์ scope ที่จำเป็น
• ค่า scope ไม่ถูกต้อง (ต้องเป็น "audit")
• โครงสร้าง filters object ไม่ถูกต้อง
• รูปแบบวันที่ไม่ถูกต้องในตัวกรอง
• ค่า enum ไม่ถูกต้องสำหรับ actor_type, auditable_type หรือ verb

401

Unauthorized

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

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

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

403

Forbidden

การเข้าถึงถูกปฏิเสธ บัญชีของคุณไม่มีสิทธิ์เข้าถึงบันทึก audit

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

• สิทธิ์บัญชีไม่เพียงพอ
• บันทึก audit ไม่ได้เปิดใช้งานสำหรับบัญชีของคุณ
• API key ไม่มีสิทธิ์อ่าน audit

5xx

Server error

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/audits/search \
  -X GET \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=audit" \
  -d "filters[created]=2024/01/01..2024/12/31" \
  -d "filters[actor_email][]=admin@example.com" \
  -d "filters[verb]=rules_switched"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = Omise::Search.execute(
  'audit',
  filters: {
    created: '2024/01/01..2024/12/31',
    actor_email: ['admin@example.com'],
    verb: 'rules_switched'
  }
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = omise.Search.execute(
    'audit',
    filters={
        'created': '2024/01/01..2024/12/31',
        'actor_email': ['admin@example.com'],
        'verb': 'rules_switched'
    }
)

Node.js

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

const search = await omise.search.list({
  scope: 'audit',
  filters: {
    created: '2024/01/01..2024/12/31',
    actor_email: ['admin@example.com'],
    verb: 'rules_switched'
  }
});

PHP

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

$search = OmiseSearch::execute([
    'scope' => 'audit',
    'filters' => [
        'created' => '2024/01/01..2024/12/31',
        'actor_email' => ['admin@example.com'],
        'verb' => 'rules_switched'
    ]
]);

Java

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

SearchResult<Audit> search = client.search()
    .scope(SearchScope.Audit)
    .filter("created", "2024/01/01..2024/12/31")
    .filter("actor_email", Arrays.asList("admin@example.com"))
    .filter("verb", "rules_switched")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var search = await client.Search.Execute(new SearchRequest
{
    Scope = "audit",
    Filters = new Dictionary<string, object>
    {
        { "created", "2024/01/01..2024/12/31" },
        { "actor_email", new[] { "admin@example.com" } },
        { "verb", "rules_switched" }
    }
});

Go

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

search, _ := client.Search(&operations.SearchOptions{
    Scope: "audit",
    Filters: map[string]interface{}{
        "created":     "2024/01/01..2024/12/31",
        "actor_email": []string{"admin@example.com"},
        "verb":        "rules_switched",
    },
})

---

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

รูปแบบตัวกรองทั่วไป

ไวยากรณ์ตัวกรอง	คำอธิบาย	ตัวอย่าง
filters[created]=date..date	ช่วงวันที่	2024/01/01..2024/12/31
filters[actor_email][]=value	อาร์เรย์อีเมล	admin@example.com
filters[verb]=value	จับคู่แบบตรง	rules_switched
filters[auditable_type]=value	ประเภททรัพยากร	routing_group

ตัวกรองที่ใช้ได้

ตัวกรอง	ประเภท	คำอธิบาย
created	date-time	กรองตาม timestamp การดำเนินการ
actor_email	array	กรองตามอีเมลผู้ใช้
actor_type	string	กรองตามประเภทผู้ดำเนินการ (user)
auditable_type	string	กรองตามประเภททรัพยากร (routing_group)
auditable_uid	string	กรองตามตัวระบุทรัพยากร
verb	string	กรองตามประเภทการดำเนินการ (rules_switched)

---

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

▼

ลองใช้งาน

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

▼

scope(จำเป็น)

แนะนำ - 3 ฟิลด์

▼

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

▼

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