多产品

Magento产品目录API

最新更新日期:Oct262023

可使用云产品目录API提供URL和产品SKU举个例子,如果您有云式媒体资产可用,您可使用产品目录API向产品列表页批量添加这些内容。也可以检索所有链接到特定SKU或skUs集的媒体

上页:

评分本页 :

配置

配置 API时,确保安装云插件API建在Magento2ARESTAPI顶端上, 因此你需要创建新集成程序允许访问通过API编辑产品目录

创建集成式

Magento管理板中选择系统化>整合.
选择添加新集成
内集成信息标签输入相关信息以及用户名和密码
内API系统标签下分类表>盘点>产品类选择选项质量更新属性,编辑产品设计并编辑分类设计提供集成访问编辑产品媒体
添加后选择激活并允许访问所选API
取回您的存取令牌中,您会用它验证API请求

验证

API使用代理验证.发送创建新集成时检索到的令牌例举 :

Authorization: Bearer abc123mytoken123

上头内容类型所有请求都需标题化将永远如此application/json.例举 :

Content-Type: application/json

端点

API建在MagentoRESTAPI顶部,基础URL相同

https://{MAGENTO_HOST_OR_IP}/{MAGENTO_BASE_INSTALL_DIR}/rest/V1

云式插件创建四大端点

方法论	描述性
获取`cloudinary/products/:sku/media`	获取媒体专用SKU
Post应用`cloudinary/products/media/get`	获取多SKUs媒体
Post应用`cloudinary/products/:sku/media`	向SKU添加媒体
Post应用`cloudinary/productGallery/addItems`	添加媒体多SKUs

获取媒体专用SKU

列表所有媒体资产URL

语法

GET /cloudinary/products/:sku/media

参数解析

参数	类型	描述性
斯库	字符串	需求化.产品SKU返回媒体

实例

获取媒体资产skU产品 my-product-sku

Curl

curl https://my-magento-shop.com/rest/V1/cloudinary/products/my-product-sku/media \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access-token>' \

样本响应

响应解析JSON

JSON

"{\"data\":{\"image\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"small_image\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"thumbnail\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"media_gallery\":[\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\"]}}"

获取多SKUs媒体

列表所有媒体资产URL指定skUs

语法

POST /cloudinary/products/media/get

参数解析

参数	类型	描述性
斯库斯	数组	需求化.数组产品SKUs返回媒体

实例

获取媒体资产产品SKUs“my-product-sku1”和“my-product-sku2”

curl  -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/products/media/get' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access-token>' \
-d '{
    "skus": ["my-product-sku1","my-product-sku2"]
}'

样本响应

响应解析JSON

JSON

"{\"data\":{\"my-product-sku1\":{\"image\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"small_image\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"thumbnail\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"media_gallery\":[\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\"]},\"my-product-sku2\":{\"image\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"small_image\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"thumbnail\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\",\"media_gallery\":[\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/c_lpad,d_sample.jpg,dpr_2.0,f_auto,q_auto\\/v1\\/media\\/catalog\\/product\\/w\\/t\\/my-product-sku_main_1.jpg\"]}}}"

向SKU添加媒体

向指定的SKU添加媒体资产URL

语法

POST /cloudinary/products/:sku/media

查询参数

参数	类型	描述性
斯库	字符串	需求化.产品SKU返回媒体

人体参数

参数	类型	描述性
URLS	数组	需求化.数组URL对象内含云式URLs(可选公有IDs)添加产品

URL对象参数

参数	类型	描述性
URL	字符串	需求化.云式媒体URL添加到产品中
公共标识	字符串	可选性.云公共标识工具添加到产品中只有当云式URL不包含版本化.
角色划分	字符串或数组	可选性.上头产品图像角色图像添加到产品中可以是字符串数组或含有逗号分离列表的单字符串
标签标签	字符串	可选性.标签关联图像替代文本使用
禁用	布尔	可选性.图像是否从产品页隐藏默认:`虚伪`.
焊德斯宾塞	字符串	标签名用于springset

实例

SKU产品“my-product-sku”添加媒体资产

curl  -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/products/my-product-sku/media' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access-token>' \
-d '{
    "urls": [
        {
            "url": "https://res.www.agrosoland.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample.jpg",
            "publicId": null,
            "disabled": 0,
            "label": "Some Alt Text"
        },
        {
            "publicId": null,
            "disabled": 0,
            "label": "Some Alt Text",
            "cldspinset": "my-spinset-1"
        },
        {
            "url": "https://res.www.agrosoland.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample.jpg",
            "publicId": null,
            "disabled": 0,
            "label": "Some Alt Text",
            "cldspinset": "my-spinset-2"
        },
        {
            "url": "https://res.www.agrosoland.com/myMagentoCloud/video/upload/v1563701653/sample.mp4",
            "publicId": null
        }
    ]
}'

样本响应

响应解析JSON

JSON

"{\"passed\":4,\"failed\":{\"count\":0,\"urls\":[]},\"message\":\"All items have been added to queue.\"}"

添加媒体多SKUs

向多SKUs添加媒体资产URL

语法

POST /cloudinary/productGallery/addItems

参数解析

参数	类型	描述性
项名	数组	需求化.数组项对象内含SKU添加介质和云式URLs

项目对象参数

参数	类型	描述性
斯库	字符串	需求化.产品SKU返回媒体
URL	字符串	需求化.云式媒体URL添加到产品中
公共标识	字符串	可选性.云公共标识工具添加到产品中只有当云式URL不包含版本化.
角色划分	字符串或数组	可选性.上头产品图像角色图像添加到产品中可以是字符串数组或含有逗号分离列表的单字符串
标签标签	字符串	可选性.标签关联图像替代文本使用
禁用	布尔	可选性.图像是否从产品页隐藏默认:`虚伪`.
焊德斯宾塞	字符串	可选性.标签名用于springset

实例

添加媒体资产产品SKUs“my-product-sku1和my-product-sku2”

curl  -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/productGallery/addItems' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access-token>' \
-d '{
    "items": [
        {
            "url": "https://res.www.agrosoland.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample.jpg",
            "sku": "my-product-sku1",
            "publicId": null,
            "disabled": 0,
            "label": "Some Alt Text"
        },
        {
            "url": "https://res.www.agrosoland.com/myMagentoCloud/video/upload/v1563701653/sample.mp4",
            "sku": "my-product-sku2",
            "publicId": null
        }
    ]
}'

样本响应

响应解析JSON

JSON

"{\"errors\":0,\"items\":[{\"url\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/image\\/upload\\/e_blur:100,r_16\\/a_178\\/v1523871670\\/sample.jpg\",\"sku\":\"my-product-sku1\",\"publicId\":null,\"disabled\":0,\"label\":\"Some Alt Text\",\"error\":0,\"message\":\"The item was added to the queue.\"},{\"url\":\"https:\\/\\/res.www.agrosoland.com\\/myMagentoCloud\\/video\\/upload\\/v1563701653\\/sample.mp4\",\"sku\":\"my-product-sku2\",\"publicId\":null,\"error\":0,\"message\":\"The item was added to the queue.\"}],\"message\":\"All items have been added to queue.\"}"

从SKU删除媒体

从指定的SKU删除媒体资产URL

语法

POST /cloudinary/products/:sku/mediaremove

查询参数

参数	类型	描述性
斯库	字符串	需求化.产品SKU清除介质

人体参数

参数	类型	描述性
URLS	数组	需求化.数组云式URL从产品中去除
delete_all_gallery	布尔	可选性.是否从产品中删除所有媒体默认:`虚伪`.

实例

SKU产品“my-product-sku”添加媒体资产

curl  -X POST 'https://my-magento-shop.com/rest/V1/cloudinary/products/my-product-sku/mediaremove' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access-token>' \
-d '{
    "urls": [
       "https://my-magento-shop.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample1.jpg",
       "https://my-magento-shop.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample2.jpg"
       "https://my-magento-shop.com/myMagentoCloud/image/upload/e_blur:100,r_16/a_178/v1523871670/sample3.jpg"
    ]
}'

样本响应

响应解析JSON

JSON

"{\"passed\":3,\"failed\":{\"count\":0,\"urls\":[]}}"

反馈发送

✖️

错误

不幸有错误发送反馈