เอกสารอ้างอิงสิทธิ์การเข้าถึง
Stripe Apps ใช้ระบบสิทธิ์การเข้าถึงเพื่อควบคุมการเข้าถึงทรัพยากรของ Stripe API สิทธิ์แต่ละรายการต้องประกาศไว้อย่างชัดเจนใน manifest ของแอป พร้อมคำอธิบายวัตถุประสงค์ที่ชัดเจน ผู้ใช้จะอนุมัติสิทธิ์เหล่านี้ตอนติดตั้งแอปของคุณ
Caution
สถานะ: วางแผนไว้ ขณะนี้ยังไม่มีแอป Tajo บน Stripe App Marketplace ตัวระบุแอป URL รวมถึงข้อมูลรับรองในหน้านี้เป็นตัวอย่างประกอบคำอธิบาย ไม่ใช่ปลายทางที่ใช้งานได้จริง
การจัดการสิทธิ์การเข้าถึง
การประกาศสิทธิ์
เพิ่มสิทธิ์ลงใน manifest stripe-app.json ของคุณ
{ "permissions": [ { "permission": "customer_read", "purpose": "Read customer profiles to sync with Brevo contacts" }, { "permission": "customer_write", "purpose": "Update customer metadata with Brevo sync status" } ]}การให้สิทธิ์ผ่าน CLI
ระหว่างการพัฒนา คุณให้สิทธิ์ผ่าน Stripe CLI ได้
# Grant a specific permissionstripe apps grant permission "customer_read" \ --purpose "Read customer profiles to sync with Brevo contacts"
# Grant multiple permissionsstripe apps grant permission "charge_read" \ --purpose "Access payment data for event tracking"
stripe apps grant permission "event_read" \ --purpose "Subscribe to real-time Stripe events"แนวปฏิบัติที่ดีสำหรับสิทธิ์การเข้าถึง
- ขอเท่าที่จำเป็นที่สุด: ขอเฉพาะสิทธิ์ที่แอปของคุณใช้งานจริง
- ระบุวัตถุประสงค์ให้ชัดเจน: เขียนคำอธิบายวัตถุประสงค์ที่ผู้ใช้ทั่วไปเข้าใจได้
- อธิบายเหตุผลเมื่อขอทั้งอ่านและเขียน: หากคุณต้องการทั้งสิทธิ์อ่านและเขียน ให้อธิบายเหตุผลในวัตถุประสงค์ของแต่ละรายการ
- ทบทวนอย่างสม่ำเสมอ: ลบสิทธิ์ที่ไม่จำเป็นแล้วออกทุกครั้งที่อัปเดตแอป
Tip
การขอสิทธิ์เกินความจำเป็นเป็นหนึ่งในสาเหตุที่แอปถูกปฏิเสธบ่อยที่สุด ขอเฉพาะสิ่งที่คุณต้องใช้เท่านั้น
สิทธิ์การเข้าถึงแยกตามผลิตภัณฑ์
Core
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Account | account_read | อ่านรายละเอียดและการตั้งค่าของบัญชี |
| Account | account_write | อัปเดตการตั้งค่าของบัญชี |
| Balance | balance_read | ดูยอดคงเหลือและรายการเคลื่อนไหวของบัญชี |
| Customer | customer_read | อ่านโปรไฟล์ลูกค้า เมตาดาตา และวิธีการชำระเงิน |
| Customer | customer_write | สร้าง อัปเดต หรือลบระเบียนลูกค้า |
| Event | event_read | อ่านและสมัครรับอีเวนต์ของบัญชี |
| File | file_read | อ่านไฟล์ที่อัปโหลดไว้และลิงก์ไฟล์ |
| File | file_write | อัปโหลดไฟล์และสร้างลิงก์ไฟล์ |
| Mandate | mandate_read | อ่านคำสั่งอนุมัติการชำระเงิน |
| Product | product_read | อ่านแคตตาล็อกสินค้าและราคา |
| Product | product_write | สร้าง อัปเดต หรือลบสินค้าและราคา |
| Token | token_read | อ่านข้อมูลการชำระเงินที่แปลงเป็นโทเคนแล้ว |
| Webhook Endpoint | webhook_endpoint_read | อ่านการตั้งค่า endpoint ของ Webhook |
| Webhook Endpoint | webhook_endpoint_write | สร้าง อัปเดต หรือลบ endpoint ของ Webhook |
Payments
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Charge | charge_read | อ่านรายการเรียกเก็บเงินและการคืนเงิน |
| Charge | charge_write | สร้างรายการเรียกเก็บเงิน ยืนยันการรับชำระ และคืนเงิน |
| Dispute | dispute_read | อ่านข้อโต้แย้งการชำระเงินและหลักฐานประกอบ |
| Dispute | dispute_write | ส่งหลักฐานและตอบกลับข้อโต้แย้ง |
| Payment Intent | payment_intent_read | อ่านรายละเอียดและสถานะของ Payment Intent |
| Payment Intent | payment_intent_write | สร้าง ยืนยัน หรือยกเลิก Payment Intent |
| Payment Method | payment_method_read | อ่านวิธีการชำระเงินที่บันทึกไว้ |
| Payment Method | payment_method_write | ผูกหรือยกเลิกการผูกวิธีการชำระเงินกับลูกค้า |
| Payout | payout_read | อ่านรายละเอียดและกำหนดการโอนเงินออก |
| Payout | payout_write | สร้างหรือยกเลิกการโอนเงินออก |
| Refund | refund_read | อ่านรายละเอียดการคืนเงิน |
| Refund | refund_write | สร้างหรืออัปเดตการคืนเงิน |
| Setup Intent | setup_intent_read | อ่านรายละเอียดของ Setup Intent |
| Setup Intent | setup_intent_write | สร้างหรือยืนยัน Setup Intent |
Billing
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Coupon | coupon_read | อ่านคูปองส่วนลดและรหัสโปรโมชัน |
| Coupon | coupon_write | สร้าง อัปเดต หรือลบคูปอง |
| Credit Note | credit_note_read | อ่านใบลดหนี้ |
| Credit Note | credit_note_write | สร้างหรือยกเลิกใบลดหนี้ |
| Invoice | invoice_read | อ่านรายละเอียด รายการสินค้า และสถานะของใบแจ้งหนี้ |
| Invoice | invoice_write | สร้าง อัปเดต สรุปยอด หรือยกเลิกใบแจ้งหนี้ |
| Invoice Item | invoice_item_read | อ่านรายการในใบแจ้งหนี้ที่รอดำเนินการ |
| Invoice Item | invoice_item_write | สร้างหรือลบรายการในใบแจ้งหนี้ |
| Plan | plan_read | อ่านแพ็กเกจการสมัครสมาชิกและราคา |
| Plan | plan_write | สร้าง อัปเดต หรือลบแพ็กเกจ |
| Price | price_read | อ่านการตั้งค่าราคา |
| Price | price_write | สร้างหรืออัปเดตราคา |
| Quote | quote_read | อ่านใบเสนอราคา |
| Quote | quote_write | สร้าง สรุปยอด หรือยอมรับใบเสนอราคา |
| Subscription | subscription_read | อ่านรายละเอียด กำหนดการ และสถานะของการสมัครสมาชิก |
| Subscription | subscription_write | สร้าง อัปเดต หรือยกเลิกการสมัครสมาชิก |
| Subscription Schedule | subscription_schedule_read | อ่านกำหนดการของการสมัครสมาชิก |
| Subscription Schedule | subscription_schedule_write | สร้าง อัปเดต หรือปล่อยกำหนดการของการสมัครสมาชิก |
| Usage Record | usage_record_read | อ่านระเบียนการใช้งานสำหรับการเรียกเก็บตามปริมาณ |
| Usage Record | usage_record_write | สร้างระเบียนการใช้งานสำหรับการเรียกเก็บตามปริมาณ |
Checkout
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Checkout Session | checkout_session_read | อ่านรายละเอียดและรายการสินค้าของ Checkout Session |
| Checkout Session | checkout_session_write | สร้างหรือทำให้ Checkout Session หมดอายุ |
| Payment Link | payment_link_read | อ่านการตั้งค่าของ Payment Link |
| Payment Link | payment_link_write | สร้างหรืออัปเดต Payment Link |
Connect
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Application Fee | application_fee_read | อ่านรายละเอียดค่าธรรมเนียมของแอปพลิเคชัน |
| Connected Account | connected_account_read | อ่านรายละเอียดของบัญชีที่เชื่อมต่อไว้ |
| Connected Account | connected_account_write | สร้างหรืออัปเดตบัญชีที่เชื่อมต่อไว้ |
| Transfer | transfer_read | อ่านรายละเอียดการโอนเงินระหว่างบัญชี |
| Transfer | transfer_write | สร้างรายการโอนเงินไปยังบัญชีที่เชื่อมต่อไว้ |
| Top-up | topup_read | อ่านรายละเอียดการเติมเงิน |
| Top-up | topup_write | สร้างรายการเติมเงินเข้ายอดคงเหลือของ Stripe |
Issuing
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Issuing Card | issuing_card_read | อ่านรายละเอียดของบัตรที่ออกให้ |
| Issuing Card | issuing_card_write | สร้าง อัปเดต หรือปิดใช้งานบัตรที่ออกให้ |
| Issuing Cardholder | issuing_cardholder_read | อ่านข้อมูลของผู้ถือบัตร |
| Issuing Cardholder | issuing_cardholder_write | สร้างหรืออัปเดตผู้ถือบัตร |
| Issuing Transaction | issuing_transaction_read | อ่านรายละเอียดธุรกรรมของบัตร |
| Issuing Authorization | issuing_authorization_read | อ่านคำขออนุมัติการใช้บัตร |
| Issuing Authorization | issuing_authorization_write | อนุมัติหรือปฏิเสธคำขออนุมัติการใช้บัตร |
| Issuing Dispute | issuing_dispute_read | อ่านข้อโต้แย้งของบัตรที่ออกให้ |
| Issuing Dispute | issuing_dispute_write | สร้างหรือยื่นข้อโต้แย้งของบัตรที่ออกให้ |
Reporting
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Report Run | report_run_read | อ่านผลลัพธ์ของการประมวลผลรายงาน |
| Report Run | report_run_write | สร้างการประมวลผลรายงานใหม่ |
| Report Type | report_type_read | อ่านประเภทรายงานที่ใช้ได้ |
Tax
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Tax Calculation | tax_calculation_read | อ่านผลการคำนวณภาษี |
| Tax Calculation | tax_calculation_write | สร้างการคำนวณภาษี |
| Tax Rate | tax_rate_read | อ่านการตั้งค่าอัตราภาษี |
| Tax Rate | tax_rate_write | สร้างหรืออัปเดตอัตราภาษี |
| Tax Registration | tax_registration_read | อ่านรายละเอียดการจดทะเบียนภาษี |
Terminal
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Terminal Reader | terminal_reader_read | อ่านรายละเอียดของเครื่องอ่านบัตร |
| Terminal Reader | terminal_reader_write | ลงทะเบียนหรืออัปเดตเครื่องอ่านบัตร |
| Terminal Location | terminal_location_read | อ่านรายละเอียดสถานที่ตั้งของเครื่องรับชำระ |
| Terminal Location | terminal_location_write | สร้างหรืออัปเดตสถานที่ตั้งของเครื่องรับชำระ |
Secret Store
| ทรัพยากร | สิทธิ์ | คำอธิบาย |
|---|---|---|
| Secret | secret_read | อ่านค่าลับจาก Secret Store |
| Secret | secret_write | สร้าง อัปเดต หรือลบค่าลับ |
สิทธิ์ที่แนะนำสำหรับการเชื่อมต่อ Tajo กับ Brevo
สำหรับแอปเชื่อมต่อ Tajo กับ Brevo นี่คือสิทธิ์ที่แนะนำ
{ "permissions": [ { "permission": "customer_read", "purpose": "Sync customer profiles and contact information to Brevo" }, { "permission": "customer_write", "purpose": "Store Brevo contact ID and sync status on customer metadata" }, { "permission": "charge_read", "purpose": "Track purchase events and revenue data for Brevo analytics" }, { "permission": "product_read", "purpose": "Sync product catalog to Brevo for personalized email campaigns" }, { "permission": "event_read", "purpose": "Listen to real-time events to trigger Brevo automation workflows" }, { "permission": "invoice_read", "purpose": "Track invoice events for transactional emails via Brevo" }, { "permission": "subscription_read", "purpose": "Monitor subscription lifecycle for Brevo retention campaigns" }, { "permission": "secret_write", "purpose": "Securely store Brevo API credentials in Stripe Secret Store" }, { "permission": "secret_read", "purpose": "Retrieve stored Brevo API credentials for data sync operations" }, { "permission": "webhook_endpoint_write", "purpose": "Register webhook endpoints for real-time event delivery to Tajo" } ]}ขอบเขตของสิทธิ์การเข้าถึง
สิทธิ์การเข้าถึงทำงานได้ในขอบเขตที่ต่างกัน ขึ้นอยู่กับว่าแอปของคุณติดตั้งอยู่บนบัญชีแพลตฟอร์มหรือบัญชีที่เชื่อมต่อไว้
| ขอบเขต | คำอธิบาย |
|---|---|
| บัญชี | สิทธิ์มีผลกับข้อมูลของบัญชีที่ติดตั้งแอปเท่านั้น |
| บัญชีที่เชื่อมต่อ | สำหรับแพลตฟอร์มที่ใช้ Connect สิทธิ์สามารถขยายไปยังบัญชีที่เชื่อมต่อไว้ได้ |
Caution
เมื่อขอสิทธิ์เขียนข้อมูล ให้เตรียมพร้อมอธิบายระหว่างการตรวจสอบแอปว่าแอปของคุณแก้ไขข้อมูลอย่างไรและเมื่อใด สิทธิ์เขียนที่ไม่จำเป็นเป็นสาเหตุที่พบบ่อยของการถูกปฏิเสธ