Magento – How to add media gallery entries via REST API – Magento 2

gallerymagento2.0.8mediarest

I stored image in pub/media/catalog/product. How to add that images into media gallery entries.

I have tried like http://myhost/rest/V1/products

"media_gallery_entries"=> array(
    array(
        "media_type"=> "image",
        "label"=> "Product Image",
        "position"=> 1,
        "disabled"=> false,
        "types"=> array(
            "image",
            "small_image",
            "thumbnail"
        ),
        "file"=> "/1/0/10.jpg"
    )
),

but it always complain about "message":"The image content is not valid."

base64_encode is the only way to add image into rest api?

if yes I tried with

"media_gallery_entries"=> array(
    array(
        "media_type"=> "image",
        "label"=> "Product Image",
        "position"=> 1,
        "disabled"=> false,
        "types"=> array(
            "image",
            "small_image",
            "thumbnail"
        ),
        "content"=> array(
            "base64_encoded_data"=> $data->getMainImage(),
            "type"=> "image/jpeg",
            "name"=> "test.jpg"
        ),
    )
),

It throws exception "message":"The image MIME type is not valid or not supported."

I found supported mime type in /vendor/magento/framework/Api/ImageContentValidator.php

private $defaultMimeTypes = [
    'image/jpg',
    'image/jpeg',
    'image/gif',
    'image/png',
];

It support image/jpeg, but I don't know why it throws exception.

Can anyone enlighten me to how to add media galleries entries?

Best Answer

Try with your second example, but instead of media_type, use mediaType tag.

"media_gallery_entries"=> array(
    array(
        "media_type"=> "image",
        "label"=> "Product Image",
        "position"=> 1,
        "disabled"=> false,
        "types"=> array(
            "image",
            "small_image",
            "thumbnail"
        ),
        "content"=> array(
            "base64_encoded_data"=> $data->getMainImage(),
            "type"=> "image/jpeg",
            "name"=> "test.jpg"
        ),
    )
),

Also, you'll probably have to use base64_encode($data->getMainImage()) instead of $data->getMainImage() only.

Related Solutions

Magento 2 – Add YouTube Video to Media Gallery Programmatically

this seems to be a bug in the Api.

Looking at the Rest Api Documentation of the catalogProductAttributeMediaGalleryManagementV1 Resource, the Image Content seems to be required while the Video content is optional:

http://devdocs.magento.com/swagger/index.html

Magento – Magento 2 Get Media Gallery in productlist

create helper for example :

<?php
/**
 * Copyright © 2015 Magento. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Ibnab\Common\Helper;
use Magento\Catalog\Model\Product\Gallery\ReadHandler as GalleryReadHandler;
class Data extends \Magento\Framework\App\Helper\AbstractHelper {
  protected $galleryReadHandler;
    /**
     * Catalog Image Helper
     *
     * @var \Magento\Catalog\Helper\Image
     */
    protected $imageHelper;
    public function __construct(
    GalleryReadHandler $galleryReadHandler,  \Magento\Framework\App\Helper\Context $context,\Magento\Catalog\Helper\Image $imageHelper)
    {
        $this->imageHelper = $imageHelper;
        $this->galleryReadHandler = $galleryReadHandler;
        parent::__construct($context);
    }
   /** Add image gallery to $product */
    public function addGallery($product) {
        $this->galleryReadHandler->execute($product);
    }
    public function getGalleryImages(\Magento\Catalog\Api\Data\ProductInterface $product)
    {
        $images = $product->getMediaGalleryImages();
        if ($images instanceof \Magento\Framework\Data\Collection) {
            foreach ($images as $image) {
                /** @var $image \Magento\Catalog\Model\Product\Image */
                $image->setData(
                    'small_image_url',
                    $this->imageHelper->init($product, 'product_page_image_small')
                        ->setImageFile($image->getFile())
                        ->getUrl()
                );
                $image->setData(
                    'medium_image_url',
                    $this->imageHelper->init($product, 'product_page_image_medium')
                        ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
                        ->setImageFile($image->getFile())
                        ->getUrl()
                );
                $image->setData(
                    'large_image_url',
                    $this->imageHelper->init($product, 'product_page_image_large')
                        ->constrainOnly(true)->keepAspectRatio(true)->keepFrame(false)
                        ->setImageFile($image->getFile())
                        ->getUrl()
                );
            }
        }
        return $images;
    }
}

call and use inside your list.phtml : $_helperGallery = $this->helper('Ibnab\Common\Helper\Data'); now you can use with current called product inside for each (with you technique):

  <a href="<?php echo $_product->getProductUrl() ?>">
                            <ul class="product-item-wrapper">
                                <?php
                                $_helperGallery->addGallery($_product);
                                $images = $_helperGallery->getGalleryImages($_product);
                                if ($images instanceof \Magento\Framework\Data\Collection) {
                                    $i = 1;
                                    foreach ($images as $image) {
                                        $item = $image->getData();
                                        if (isset($item['media_type']) && $item['media_type'] == 'image'):
                                            ?>
                                            <?php if ($i == 1): ?>
                                                <li class="selected">
                                                <?php else: ?>
                                                <li >
                                                <?php endif; ?>
                                                <img src="<?php echo isset($item['medium_image_url']) ? $item['medium_image_url'] : null; ?>" alt="Preview image">
                                            </li>
                                            <?php
                                            $i++;
                                        endif;
                                    }
                                }
                                ?>
                            </ul>
                        </a>

the complete source of course

Best Answer

Related Solutions

Magento 2 – Add YouTube Video to Media Gallery Programmatically

Magento – Magento 2 Get Media Gallery in productlist

Related Topic