إنشاء نوع إيصال
curl --request POST \
--url https://api.truthlocks.com/v1/receipt-types \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: '<string>', name: '<string>', schema: '<unknown>'})
};
fetch('https://api.truthlocks.com/v1/receipt-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/receipt-types"
payload = {
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/receipt-types"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"name": "<string>",
"display_name": "<string>",
"schema": {},
"created_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}الإيصالات
إنشاء نوع إيصال
يسجل نوع إيصال مخصصًا باستخدام مخطط JSON للتحقق من صحة الحمولة.
POST
/
v1
/
receipt-types
إنشاء نوع إيصال
curl --request POST \
--url https://api.truthlocks.com/v1/receipt-types \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({display_name: '<string>', name: '<string>', schema: '<unknown>'})
};
fetch('https://api.truthlocks.com/v1/receipt-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/receipt-types"
payload = {
"display_name": "<string>",
"name": "<string>",
"schema": "<unknown>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/receipt-types"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"name\": \"<string>\",\n \"schema\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"name": "<string>",
"display_name": "<string>",
"schema": {},
"created_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}ينشئ نوع إيصال مخصص للمستأجر مع مخطط JSON للتحقق من صحة الحمولة. الأنواع المحددة بواسطة النظام الأساسي (
payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) للقراءة فقط ولا يمكن تجاوزها أو استبدالها.
يتم عزل الأنواع المخصصة للمستأجر المصادق عليه بواسطة أمان مستوى الصف. لا يمكن للمستأجرين الآخرين رؤية أو استخدام أنواعك المخصصة.
نص الطلب
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
name | string | نعم | معرّف فريد بصيغة snake_case (مثال: invoice_receipt). يجب ألا يتعارض مع أسماء أنواع المنصات. |
display_name | string | نعم | تسمية قابلة للقراءة البشرية تظهر في واجهة مستخدم وحدة التحكم. |
version | string | لا | سلسلة SemVer (افتراضيًا 1.0.0). أنشئ إصدارات متعددة لإدارة تطور المخطط. |
schema | object | نعم | مخطط JSON صالح (مسودة 2020-12) يصف بنية payload المطلوبة. |
description | string | لا | وصف نصي عادي للتوثيق. |
متطلبات المخطط
يجب أن يكون الحقلschema مخطط JSON صالحًا (مسودة 2020-12). قم بتضمين مصفوفة required لفرض حقول الحمولة الإلزامية عند سك العملة.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": ["invoice_number", "amount", "currency"],
"properties": {
"invoice_number": { "type": "string" },
"amount": { "type": "integer", "description": "Amount in smallest currency unit" },
"currency": { "type": "string", "minLength": 3, "maxLength": 3 }
},
"additionalProperties": false
}
تحديد الإصدارات
أنشئ إصدارات متعددة من نفس النوع عن طريق تمرير قيمversion مختلفة (1.0.0، 2.0.0، إلخ). تقوم الإيصالات دائمًا بتثبيت الإصدار في وقت السك، لذا لا تتأثر الإيصالات الموجودة عند تقديم إصدار جديد.
لإهمال إصدار قديم، استخدم PATCH /v1/receipt-types/{name} مع {"status": "deprecated"}.
الاستجابات
الجسم
application/json

