Connectors
Store platform connectors (modules and plugins).
4 نقاط وصول. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.
POST /v1/connectors/{connector_id}/syncGET /v1/connectorsPOST /v1/connectorsPATCH /v1/connectors/{connector_id}
POST
/v1/connectors/{connector_id}/syncPull a full sync from the store now
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
connector_id | path | string | نعم |
الردود
- 202Successful Response
Accepted
GET
/v1/connectorsInstalled connectors
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
الردود
- 200Successful Response
ConnectorOut[]
POST
/v1/connectorsRegister a store connector (its 'Test connection' button)
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
Idempotency-Key | header | string | null | لا | Unique per logical write (8-255 chars). Retries with the same key are safe. · pattern ^[A-Za-z0-9_\-:.]{8,255}$ |
جسم الطلب application/json ConnectorRegister
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
platform | "opencart" | "woocommerce" | "shopify" | "salla" | "zid" | "magento" | "custom" | نعم | |
store_url | string | نعم | max length 500 |
platform_version | string | null | لا | max length 32 |
module_version | string | null | لا | max length 32 |
settings | object | لا |
الردود
- 200Successful Response
ConnectorOut
PATCH
/v1/connectors/{connector_id}Turn a connector on/off or change its settings
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
connector_id | path | string | نعم |
جسم الطلب application/json ConnectorUpdate
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
enabled | boolean | null | لا | |
settings | object | null | لا |
الردود
- 200Successful Response
ConnectorOut
أشكال البيانات في هذه الصفحة
Accepted
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
accepted | boolean | لا | default true |
job | Job | null | لا |
Job
A row of the shared `jobs` table. Poll GET /v1/jobs/{id} until status is terminal.
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
kind | "reindex" | "import" | "sync" | "translate_backfill" | "translate_writeback" | "export" | "data_export" | "data_delete" | "embed" | "synonym_mining" | نعم | |
status | "queued" | "running" | "succeeded" | "failed" | "canceled" | نعم | |
progress | number | لا | default 0 · min 0 · max 1 |
created_at | string (date-time) | نعم | |
started_at | string (date-time) | null | لا | |
finished_at | string (date-time) | null | لا | |
result | object | null | لا | |
error | string | null | لا |
ConnectorOut
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
id | string | نعم | |
platform | "opencart" | "woocommerce" | "shopify" | "salla" | "zid" | "magento" | "custom" | نعم | |
store_url | string | نعم | |
platform_version | string | null | لا | |
module_version | string | null | لا | |
status | "pending" | "active" | "error" | "disabled" | "uninstalled" | نعم | |
enabled | boolean | نعم | |
last_sync_at | string (date-time) | null | لا | |
last_error | string | null | لا | |
fallback_count_24h | integer | لا | default 0 |
created_at | string (date-time) | نعم |
ConnectorRegister
Sent by a connector's 'Test connection' button with its secret key.
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
platform | "opencart" | "woocommerce" | "shopify" | "salla" | "zid" | "magento" | "custom" | نعم | |
store_url | string | نعم | max length 500 |
platform_version | string | null | لا | max length 32 |
module_version | string | null | لا | max length 32 |
settings | object | لا |
ConnectorUpdate
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
enabled | boolean | null | لا | |
settings | object | null | لا |