মূল লেখায় যান

পরিচালনার API কী

অর্ডার সিস্টেম থেকে স্বয়ংক্রিয় লাইসেন্স দিতে বা সার্ভার থেকে অনুমতির তথ্য পড়তে ব্যবস্থাপনা API Key ব্যবহার করুন। এটি আপনার বিক্রেতা কর্মক্ষেত্রের পরিচয়।

ক্লায়েন্টের কোন কী লাগে?

পরিচয়পত্রকাকে দেবেনকী কাজে লাগে
lv_api_…
পরিচালনার API কী
আপনার নিজস্ব সার্ভারপণ্য, নীতি, লাইসেন্স তৈরি; ডিভাইস, ব্যবহার ও অডিট দেখুন
lv_lic_…
লাইসেন্স কী
গ্রাহকের সফটওয়্যারসক্রিয়, যাচাই, হার্টবিট ও ডিভাইস মুক্ত
পণ্যের পাবলিক কীক্লায়েন্টের সঙ্গে দিনসার্ভারের লাইসেন্স স্বাক্ষর যাচাই

গ্রাহকের সফটওয়্যারে অনুমতি যাচাইয়ে লাইসেন্স কী যথেষ্ট। ব্যবস্থাপনা API Key পুরো কর্মক্ষেত্র নিয়ন্ত্রণ করে; গ্রাহকের সফটওয়্যার বা প্রকাশ্য পাতায় রাখবেন না।

একটি কী তৈরি

  1. ওয়ার্কস্পেস Owner হিসেবে লগইন করে খুলুন API Key এবং API Key তৈরি চাপুন।
  2. কাজ অনুযায়ী নাম দিন, যেমন “অর্ডার সিস্টেম”। পড়তে শুধু-পড়া, লাইসেন্স তৈরি বা বদলাতে পড়া/লেখা বাছুন। মেয়াদ 1–365 দিন।
  3. সংরক্ষণের পর সম্পূর্ণ Key কপি করুন; একবারই দেখানো হয়। সার্ভারের ব্যক্তিগত কনফিগ বা পরিবেশ চলকে রাখুন।

প্রথম ম্যানেজমেন্ট অনুরোধ পাঠান

উদাহরণটি পণ্যের তালিকা পড়ে। দিন LICENTIVO_URL লাইসেন্স সার্ভারের URL এবং দিন LICENTIVO_API_KEY সদ্য তৈরি সম্পূর্ণ কী, তারপর চালান:

curl
curl "$LICENTIVO_URL/api/v1/products?limit=25" \
  -H "Authorization: Bearer $LICENTIVO_API_KEY"

এটি Bash/macOS/Linux-এর রীতি। Windows PowerShell-এ ব্যবহার করুন curl.exe; পরিবেশ ভেরিয়েবল হলো $env:LICENTIVO_URL ও $env:LICENTIVO_API_KEY। নয় ভাষার পূর্ণ অনুরোধও এখানে SDK পৃষ্ঠার সার্ভার ম্যানেজমেন্ট API Key বিকল্প।

সফল হলে HTTP 200 ও থাকবে data.items। Bearer Key-তে লগইন কুকি বা CSRF লাগে না।

অধিকার ও অকার্যকর হওয়ার ব্যবস্থা

শুধু-পড়া Key সম্পদ দেখায়; পড়া/লেখা Key পণ্য, নীতি ও লাইসেন্স তৈরি-বদলায়। অ্যাকাউন্ট, দল, সিস্টেম সেটিং বা অর্থপ্রদানে যথাযথ অ্যাকাউন্টে লগইন লাগে, ব্যবস্থাপনা Key নয়।

ফাঁস হওয়া বা অব্যবহৃত Key কনসোলে বাতিল করুন। বদলাতে Rotate চাপুন; পুরোনো Key সঙ্গে সঙ্গে অকার্যকর হয়। পরে সার্ভার কনফিগ বদলান।

প্যাকেজের API কোটায় সক্রিয়করণ, যাচাই, হার্টবিট ও মুক্ত করার অনুরোধ গণনা হয়। এই ব্যবস্থাপনা অনুরোধগুলো তাতে পড়ে না।

Common request and response conventions

ItemConvention
Server originLICENTIVO_URL is the license server origin. API paths start with /api/v1 ।
AuthenticationAuthorization: Bearer YOUR_MANAGEMENT_API_KEY. Read-only keys use scope=read; read/write keys use scope=write. A key accesses its own workspace. Writes also require its creator to be an active Owner.
JSON bodyFor requests with a body, send Content-Type: application/json. Bodies are limited to 64 KiB. Unknown fields, multiple JSON objects and invalid types are rejected. Operations marked {} require an empty JSON object. GET and DELETE have no body.
UpdatesPATCH preserves omitted fields. Basic updates require at least one editable field. See conditional requirements, such as duration_days।
Success and failureSuccessful JSON responses use {"data": ..., "request_id": "..."}; errors use {"error": {"code": "...", "message": "..."}, "request_id": "..."}. Creation usually returns 201, reads and updates 200, and queued tasks 202.
File responsesSuccessful CSV and ZIP responses contain file data without a data wrapper. Errors still use JSON. The X-Request-ID response header identifies the request.
PaginationPaginated operations default to limit=25, offset=0; ranges are 1–100 and 0–100000. Most lists return items ও total. Check each field table for echoed pagination parameters. Audit logs omit total. Increase offset for the next page and stop when fewer than limit items are returned. Do not rely on undocumented filters.
Dates and moneyDate strings use UTC / RFC 3339. Offline requests use created_at in Unix seconds. Amounts ending in *_cents are hundredths of the currency unit;*_micros are millionths. Interpret amounts with currency ।

Retries and idempotency

Ordinary creation, renewal and key rotation do not provide general Idempotency-Key deduplication. Do not blindly resend after a timeout; it can issue or renew twice. For reliable order processing, use POST /api/v1/licenses/batch: generate and store the body request_idper order, and keep the original ID and identical content for retries. Onboarding also deduplicates by its body request_id.

The top-level response request_id differs from the business idempotency ID: the server generates the former for each HTTP request, while you retain the latter per business operation. Poll task status after 202. On 429, wait according to Retry-After . A 5xx or lost connection can leave a write outcome uncertain; query first or recover using that operation’s idempotency rules.

Management errors and recovery
HTTP / error.codeCause and recovery
400 INVALID_INPUT
415 JSON_REQUIRED
Correct fields, conditional requirements or Content-Type before retrying.
401 UNAUTHENTICATEDThe key is malformed, expired or revoked, or its account/workspace is inactive. Check the complete key and account state.
403 FORBIDDEN
403 CSRF_INVALID
Check scope, Owner role and session requirements. CSRF tokens for cookie-authenticated writes must match the session.
404 NOT_FOUND
405 METHOD_NOT_ALLOWED
Check the resource ID, workspace, archive state and HTTP method. A 405 response lists allowed methods in Allow.
409 PRODUCT_DISABLED
409 RESOURCE_IN_USE
Enable the product first. Resolve dependent resources before archiving a product or policy.
409 LICENSE_REVOKED
409 PERPETUAL_LICENSE
Revoked licenses cannot be restored or renewed. Perpetual licenses have no usage expiry to extend.
409 DEVICE_LIMIT_BELOW_ACTIVE
409 ACTIVE_DEVICES_CONFLICT
Release excess devices/sessions before lowering limits or switching license models.
409 POLICY_CHANGED
409 PREVIEW_STALE
Reload the policy revision or preview the changes again before submitting; preserve concurrent updates.
409 IDEMPOTENCY_CONFLICTThe business request_id was reused with different content. Retries retain the original ID and body; new operations need a new ID.
409 KEY_LIMIT
409 KEY_INACTIVE
At most 100 active keys are allowed; revoke unused keys. Rotation requires an active key whose creator remains an active Owner.
409 PLAN_VERSION_CONFLICT
409 INVOICE_STATE_CONFLICT
409 JOB_STATE_CONFLICT
Reload pricing, invoice or task state before proceeding. Only failed billing tasks can be retried.
409 DELIVERY_RUNNING
409 WEBHOOK_DISABLED
Wait for the running delivery or enable the endpoint first. Receivers must deduplicate by event ID.
413 EXPORT_TOO_LARGE
429 RATE_LIMITED
Filter exports to at most 5000 rows or use pagination. Wait according to Retry-After when rate-limited.
500 INTERNAL_ERROR
503 DEFAULT_PLAN_DISABLED
Keep request_id for diagnosis; contact an administrator if the default allowance is disabled. Recover uncertain writes according to the operation’s idempotency rules.

Offline operations may also return runtime licensing errors; see Troubleshooting and licensing errors।

Technical terminology
মেয়াদঅর্থ
authentication / authorizationAuthentication / authorization: establish the credential’s identity, then check permission for the operation.
scopeScope: read grants read access and write grants read/write access; separate from the Owner / read_only account role.
policy / plan / purchaseLicensing policy / billing plan / package purchase contract: software licensing rules, service prices and purchased entitlements respectively.
license / license keyLicense / license key: the management record and the customer’s activation secret respectively; both differ from the management API Key.
activation / seat / leaseActivation / seat / authorization lease: a device or session record, a concurrent-use slot, and time-bounded server-signed authorization respectively.
revoke / suspend / archive / releaseRevoke / suspend / archive / release: revocation is terminal, suspension is reversible, archiving removes normal visibility, and release frees a device or seat.
rotate / idempotency / reservationRotation / idempotency / reservation: replacing a key, preventing additional effects from repeated execution of the same operation, and reserving feature uses before committing them.

All management requests and responses

The reference covers every Bearer-key operation plus the Owner-session operations for creating, listing, rotating and revoking keys. Select an operation for calls, responses, fields and conditions. All example credentials are illustrative.

Loading API reference…

Management key permissions

Read-only keys can call operations marked “Read or write key”; write keys also support “Write key” operations. Key lifecycle, accounts, members, system settings, payments and refunds require an authorized session. Monthly billing queries and tasks use the permissions listed here. Customer runtime operations use customer credentials; see SDK লাইসেন্স কল।

Download the machine-readable OpenAPI JSON (বর্তমান ভাষা)for import into tools such as Postman. Web field explanations follow the documentation language.