Merge branch 'YP-1351-dobavit-v-biblioteku-php-api-client-opczionalnyj-setter-idempotency-key' into 'main'

Add idempotency key

See merge request ypmn/php-api-client!2

Author: payuru

src/ApiRequest.php

@@ -44,6 +44,8 @@ class ApiRequest implements ApiRequestInterface
     /** @var string Хост для отправки запросов */
     private string $host = self::HOST;
 
+    private string $idempotencyKey;
+
     /** @inheritdoc  */
     public function __construct(MerchantInterface $merchant)
     {
@@ -68,6 +70,24 @@ public function setHost(string $host) : self
         }
     }
 
+    /** @inheritdoc */
+    public function getIdempotencyKey(): string
+    {
+        return $this->idempotencyKey;
+    }
+
+    /** @inheritdoc */
+    public function setIdempotencyKey(string $idempotencyKey): self
+    {
+        if (mb_strlen($idempotencyKey) <= 36) {
+            $this->idempotencyKey = $idempotencyKey;
+
+            return $this;
+        } else {
+            throw new PaymentException('Ключ идемпотентности должен быть не длинее 36 символов, подробнее: https://ypmn.ru/ru/documentation/#tag/idempotency');
+        }
+    }
+
     /** @deprecated старая версия */
     public function sendGetReportRequest(?string $startDate = null, ?string $endDate = null, ?array $orderStatus = null): string
     {
@@ -294,6 +314,24 @@ public function sendPostRequest($data, string $api): array
         $date = (new DateTime())->format(DateTimeInterface::ATOM);
         $requestHttpVerb = 'POST';
 
+        $headers = [
+            'Accept: application/json',
+            'Content-Type: application/json',
+            'X-Header-Date: ' . $date,
+            'X-Header-Merchant: ' . $this->merchant->getCode(),
+            'X-Header-Signature:' . $this->getSignature(
+                $this->merchant,
+                $date,
+                $this->getHost() . $api,
+                $requestHttpVerb,
+                $encodedJsonDataHash
+            )
+        ];
+
+        if ($this->getIdempotencyKey()) {
+            $headers[] = 'X-Header-Idempotency-Key: ' . $this->getIdempotencyKey();
+        }
+
         curl_setopt_array($curl, [
             CURLOPT_URL => $this->getHost() . $api,
             CURLOPT_RETURNTRANSFER => true,
@@ -303,19 +341,7 @@ public function sendPostRequest($data, string $api): array
             CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
             CURLOPT_CUSTOMREQUEST => $requestHttpVerb,
             CURLOPT_POSTFIELDS => $encodedJsonData,
-            CURLOPT_HTTPHEADER => [
-                'Accept: application/json',
-                'Content-Type: application/json',
-                'X-Header-Date: ' . $date,
-                'X-Header-Merchant: ' . $this->merchant->getCode(),
-                'X-Header-Signature:' . $this->getSignature(
-                    $this->merchant,
-                    $date,
-                    $this->getHost() . $api,
-                    $requestHttpVerb,
-                    $encodedJsonDataHash
-                )
-            ]
+            CURLOPT_HTTPHEADER => $headers
         ]);
 
         $response = curl_exec($curl);

src/ApiRequestInterface.php

@@ -128,6 +128,16 @@ public function getHost() : string;
      */
     public function setHost(string $host) : self;
 
+    /** @return string Ключ идемпотентности https://ypmn.ru/ru/documentation/#tag/idempotency */
+    public function getIdempotencyKey() : string;
+
+    /**
+     * @param string $idempotencyKey Ключ идемпотентности https://ypmn.ru/ru/documentation/#tag/idempotency
+     * @return $this
+     * @throws PaymentException
+     */
+    public function setIdempotencyKey(string $idempotencyKey) : self;
+
     /**
      * Отправить запрос на регистрацию мерчанта
      * @param PodeliMerchant $merchant