{"id":1183,"date":"2024-02-21T19:22:44","date_gmt":"2024-02-21T13:52:44","guid":{"rendered":"https:\/\/magecurious.com\/blog\/?p=1183"},"modified":"2024-02-26T19:01:31","modified_gmt":"2024-02-26T13:31:31","slug":"how-to-use-guzzlehttp-for-api-in-magento-2","status":"publish","type":"post","link":"https:\/\/magecurious.com\/blog\/how-to-use-guzzlehttp-for-api-in-magento-2\/","title":{"rendered":"How to Use GuzzleHttp for API in Magento 2"},"content":{"rendered":"\n

Hello Everyone,<\/p>\n\n\n\n

In this blog, we will learn about how to Use Guzzle Client for API Operations in Magento 2.<\/p>\n\n\n\n

What is Guzzle:<\/strong><\/h3>\n\n\n\n

Guzzle is a php http client that makes integration with some web services. Guzzle is one of the most popular tools for making HTTP requests.<\/p>\n\n\n\n

Without wasting your time, let us guide you straight away. Follow the easy step given below to Use GuzzleHTTP Client in Magento 2.<\/p>\n\n\n\n

STEPS FOR USE GUZZLEHTTP CLIENT IN MAGENTO 2<\/strong><\/h2>\n\n\n\n

To Use GuzzleHTTP we require below classes<\/strong><\/h3>\n\n\n
\nuse GuzzleHttp\\Client;\n\nuse GuzzleHttp\\ClientFactory;\n\nuse GuzzleHttp\\Exception\\GuzzleException;\n\nuse GuzzleHttp\\Psr7\\Response;\n\nuse GuzzleHttp\\Psr7\\ResponseFactory;\n\nuse Magento\\Framework\\Serialize\\Serializer\\Json;\n\nuse Magento\\Framework\\Webapi\\Rest\\Request;\n<\/pre><\/div>\n\n\n
Step 1: Install GuzzleHttp<\/strong><\/strong><\/p>\n\n\n\n
In the latest Versions of Magento GuzzleHttp is available by default. But if it is not installed then you will need to install GuzzleHttp Client via composer.<\/p>\n\n\n\n
composer require guzzlehttp\/guzzle<\/strong><\/p>\n\n\n\n
Step 2: Create Controller file GetData.php<\/strong><\/p>\n\n\n\n
app\/code\/Vendor\/Extension\/Controller\/Services\/GetData.php<\/strong><\/p>\n\n\n
\n<?php\n\nnamespace Vendor\\Extension\\Controller\\Services;\n\nuse GuzzleHttp\\Client;\n\nuse GuzzleHttp\\ClientFactory;\n\nuse GuzzleHttp\\Exception\\GuzzleException;\n\nuse GuzzleHttp\\Psr7\\Response;\n\nuse GuzzleHttp\\Psr7\\ResponseFactory;\n\nuse Magento\\Framework\\Webapi\\Rest\\Request;\n\n\/**\n\n\u00a0* Class GetData Api\n\n\u00a0*\/\n\nclass GetData\n\n{\n\n\u00a0\u00a0\u00a0\u00a0\/**\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* API request URL\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\/\n\n\u00a0\u00a0\u00a0\u00a0const API_REQUEST_URI = 'https:\/\/api.magecurious.com\/';\n\n\u00a0\u00a0\u00a0\u00a0\/**\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* API request endpoint\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\/\n\n\u00a0\u00a0\u00a0\u00a0const API_REQUEST_ENDPOINT = 'demo\/';\n\n\u00a0\u00a0\u00a0\u00a0\/**\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @var ResponseFactory\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\/\n\n\u00a0\u00a0\u00a0\u00a0private $responseFactory;\n\n\u00a0\u00a0\u00a0\u00a0\/**\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @var ClientFactory\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\/\n\n\u00a0\u00a0\u00a0\u00a0private $clientFactory;\n\n\u00a0\u00a0\u00a0\u00a0\/**\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* Constructor\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @param ClientFactory $clientFactory\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @param ResponseFactory $responseFactory\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\/\n\n\u00a0\u00a0\u00a0\u00a0public function __construct(\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0ClientFactory $clientFactory,\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0ResponseFactory $responseFactory\n\n\u00a0\u00a0\u00a0\u00a0) {\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$this->clientFactory = $clientFactory;\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$this->responseFactory = $responseFactory;\n\n\u00a0\u00a0\u00a0\u00a0}\n\n\u00a0\u00a0\u00a0\u00a0\u00a0public function execute()\n\n\u00a0\u00a0\u00a0\u00a0{\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$demoName = 'magento\/magento2';\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$response = $this->doRequest(static::API_REQUEST_ENDPOINT . $demoName);\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$status = $response->getStatusCode(); \/\/ 200 status code\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$responseBody = $response->getBody();\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$responseContent = $responseBody->getContents();\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return json_decode($responseContent);\n\n\u00a0\u00a0\u00a0\u00a0}\n\n\u00a0\u00a0\u00a0\u00a0\/**\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* Do API request with provided params\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @param string $uriEndpoint\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @param array $params\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @param string $requestMethod\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\n\n\u00a0\u00a0\u00a0\u00a0\u00a0* @return Response\n\n\u00a0\u00a0\u00a0\u00a0\u00a0*\/\n\n\u00a0\u00a0\u00a0\u00a0private function doRequest(\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0string $uriEndpoint,\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0array $params = [],\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0string $requestMethod = Request::HTTP_METHOD_GET\n\n\u00a0\u00a0\u00a0\u00a0): Response {\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/** @var Client $client *\/\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$client = $this->clientFactory->create(['config' => [\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'base_uri' => self::API_REQUEST_URI\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0]]);\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0try {\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$response = $client->request(\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$requestMethod,\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$uriEndpoint,\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$params\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0);\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0} catch (GuzzleException $exception) {\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/** @var Response $response *\/\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$response = $this->responseFactory->create([\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'status' => $exception->getCode(),\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0'reason' => $exception->getMessage()\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0]);\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $response;\n\n\u00a0\u00a0\u00a0\u00a0}\n\n}\n<\/pre><\/div>\n\n\n
This is a basic example. You have to change\/modify this code according to your requirements. You can refer to the official documentation of GuzzleHTTP.<\/p>\n\n\n\n
Step 2: Finally run the below commands<\/strong><\/p>\n\n\n
\n$ php bin\/magento cache:clean\n\n$ php bin\/magento cache:flush\n<\/pre><\/div>\n\n\n
Final Thoughts:<\/strong><\/h2>\n\n\n\n
So this was the easiest way which we have told you in this blog. This is how you can Use GuzzleHTTP Client in Magento 2. Hope you liked the blog.<\/p>\n\n\n\n
So quickly go to the comment box and tell me how you like this blog?<\/p>\n\n\n\n
Stay tuned with us on our site to get new updates of Magento.<\/strong><\/p>\n\n\n\n
Thanks for reading and visiting our site.<\/p>\n\n\n
      
          
        How useful was this post?      <\/p>              
        Click on a star to rate it!      <\/p>        
      
                      
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>              <\/ul>    <\/div>    
    <\/p>