ดึงข้อมูล API Schema

GEThttps://api.omise.co/schema

ดึง OpenAPI schema สำหรับ Omise API endpoint นี้ส่งคืนข้อกำหนด API ที่สมบูรณ์ในรูปแบบ OpenAPI 3.0 ช่วยให้คุณค้นหา endpoints ที่มี เข้าใจโครงสร้างคำขอ/การตอบกลับ และรวมเข้ากับเครื่องมือเอกสาร API

---

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

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

▼

`format`STRING(optional)

รูปแบบ response สำหรับ schema ค่าเริ่มต้นเป็น JSON

Example:"json"

Values:json, yaml

Default:"json"

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

ดึง schema สำเร็จ ส่งคืนข้อกำหนด OpenAPI 3.0 ที่สมบูรณ์

โครงสร้าง Response:

• openapi - เวอร์ชันข้อกำหนด OpenAPI (เช่น "3.0.0")
• info - metadata ของ API รวมถึงชื่อ เวอร์ชัน และคำอธิบาย
• servers - URL เซิร์ฟเวอร์ API ที่ใช้ได้
• paths - endpoints API ทั้งหมดที่มีพร้อม methods และพารามิเตอร์
• components - คำจำกัดความ schema และ security schemes ที่ใช้ซ้ำได้
• security - ข้อกำหนดความปลอดภัยทั่วไป

400

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

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

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

• ค่าพารามิเตอร์ format ไม่ถูกต้อง
• พารามิเตอร์ query ที่ไม่รองรับ

401

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

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

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

• ขาด Authorization header
• API key ไม่ถูกต้อง
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบ endpoint schema

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

• URL endpoint ไม่ถูกต้อง
• เวอร์ชัน API ไม่ถูกต้อง

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/schema \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.omise.co/schema')
request = Net::HTTP::Get.new(uri)
request.basic_auth('skey_test_5xuy4w91xqz7d1w9u0t', '')

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

schema = JSON.parse(response.body)
puts schema['openapi']

Python

import requests

response = requests.get(
    'https://api.omise.co/schema',
    auth=('skey_test_5xuy4w91xqz7d1w9u0t', '')
)

schema = response.json()
print(schema['openapi'])

Node.js

const https = require('https');

const options = {
  hostname: 'api.omise.co',
  path: '/schema',
  method: 'GET',
  auth: 'skey_test_5xuy4w91xqz7d1w9u0t:'
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const schema = JSON.parse(data);
    console.log(schema.openapi);
  });
});

req.end();

PHP

<?php
$ch = curl_init('https://api.omise.co/schema');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'skey_test_5xuy4w91xqz7d1w9u0t:');

$response = curl_exec($ch);
curl_close($ch);

$schema = json_decode($response, true);
echo $schema['openapi'];

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

HttpClient client = HttpClient.newHttpClient();

String auth = Base64.getEncoder()
    .encodeToString("skey_test_5xuy4w91xqz7d1w9u0t:".getBytes());

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.omise.co/schema"))
    .header("Authorization", "Basic " + auth)
    .GET()
    .build();

HttpResponse<String> response = client.send(request,
    HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

C#

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();

var authBytes = Encoding.ASCII.GetBytes("skey_test_5xuy4w91xqz7d1w9u0t:");
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Basic", Convert.ToBase64String(authBytes));

var response = await client.GetAsync("https://api.omise.co/schema");
var schema = await response.Content.ReadAsStringAsync();

Console.WriteLine(schema);

Go

package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.omise.co/schema", nil)
    req.SetBasicAuth("skey_test_5xuy4w91xqz7d1w9u0t", "")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)

    var schema map[string]interface{}
    json.Unmarshal(body, &schema)

    fmt.Println(schema["openapi"])
}

---

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

รหัส Error ทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า API key ถูกต้อง
bad_request	พารามิเตอร์คำขอไม่ถูกต้อง	ตรวจสอบค่าพารามิเตอร์ format

โครงสร้าง Schema

ฟิลด์	ประเภท	คำอธิบาย
openapi	string	เวอร์ชันข้อกำหนด OpenAPI
info	object	metadata ของ API (ชื่อ เวอร์ชัน คำอธิบาย)
servers	array	URL เซิร์ฟเวอร์ API ที่ใช้ได้
paths	object	endpoints API ทั้งหมดพร้อม operations
components	object	schemas พารามิเตอร์ และคำจำกัดความ security ที่ใช้ซ้ำได้
security	array	ข้อกำหนดความปลอดภัยทั่วไป
tags	array	การจัดกลุ่มทรัพยากร API

---

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

▼

ลองใช้งาน

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

▼

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