মূল কনটেন্টে যান
১৪ দিনের ফ্রি ট্রায়াল, কার্ড লাগবে না৯টি ভাষা১৭৬টি ব্যবসার ধরন · ৫০টি অ্যাপ
BN· USD
লাইভ ডেমো চালিয়ে দেখুনফ্রি ট্রায়াল শুরু করুন

API কী ও স্কোপ

একটি কী কী পড়তে ও লিখতে পারে, আর যিনি বানিয়েছেন তার কাছ থেকে কী সীমা পায়।

Authorization: Bearer fx_live_…

প্রতিটি কী যে নিয়ম মানে

  • কী একবারই দেখানো হয়; শুধু এর SHA-256 হ্যাশ রাখা হয়
  • কী শুধু সেই অংশগুলো ঢাকতে পারে যা এর নির্মাতা খুলতে পারেন; সব-অংশের কী শুধু ওয়ার্কস্পেস মালিকের
  • কী তার নির্মাতার শাখা ও কোম্পানির মধ্যে কাজ করে, ব্যাক অফিসের ব্যক্তির মতো; এর বানানো রেকর্ড সেই ব্যক্তির শাখায় যায়
  • নির্মাতা নিষ্ক্রিয় বা মুছে ফেলা হলে কী কাজ বন্ধ করে
  • কী মেয়াদোত্তীর্ণ হতে পারে এবং যেকোনো সময় বাতিল করা যায়; প্রতিটি অনুরোধ রিকোয়েস্ট লগে থাকে

কী চেনা

প্রতিটি কী fx_live_ দিয়ে শুরু হয়। কী-এর তালিকায় এর প্রথম 14টি অক্ষর দেখা যায়, তাই পুরো কী না দেখেই আলাদা করে চেনা যায়।

কোনো কী ফাঁস হলে

  1. সাথে সাথে Admin → Integrations & API-তে বাতিল করুন; পরের রিকোয়েস্ট থেকেই এটি কাজ করবে না
  2. একই স্কোপে নতুন কী তৈরি করে আপনার সিস্টেম হালনাগাদ করুন
  3. অচেনা কল আছে কি না রিকোয়েস্ট লগে দেখুন
  4. কী-টির লেখার অনুমতি থাকলে এটি যে রেকর্ড তৈরি করেছে, সেগুলো যাচাই করুন

নিচের রেফারেন্স OpenAPI ডকুমেন্টের মতোই ইংরেজিতে।

স্কোপ

customers:readList and read customers
customers:writeCreate customers and update their contact details
quotations:readList and read quotations (with items)
quotations:writeCreate draft quotations
invoices:readList and read invoices (with items and payments)
invoices:writeCreate draft invoices
orders:readList and read shop orders
inquiries:readList and read leads
inquiries:writeCreate leads (goes through the same notifications as the website form)
products:readList and read products with stock
webhooks:readRead the webhook event catalog and delivery log
payments:readList and read invoice payments
stock:readRead stock locations and stock levels
stock:writeAdd or remove stock (adjustments, write-offs)
appointments:readList and read appointments
pos:readList and read till sales and refunds
tasks:readList and read tasks
tasks:writeCreate tasks and change them (status, due date, priority)
attachments:writeUpload photos and PDFs (optionally onto a task)
sensors:writeUpload readings of sensor devices (temperature, humidity, fuel level) — Sensors & cold chain
catalog:readRead the catalog: products, product categories, services and bookable services
bookings:readRead appointments and free time slots
bookings:writeBook appointments (same checks as online booking)
webhooks:writeList, create and delete webhook endpoints

পরের: স্যান্ডবক্স ওয়ার্কস্পেস

নমুনা ডেটাসহ একটি ব্যক্তিগত ডেমো ওয়ার্কস্পেসে API চেষ্টা করুন। সেখানে যা করেন তা বাইরের জগতে পৌঁছায় না।

স্যান্ডবক্স ওয়ার্কস্পেস