Merge branch 'add-idempotency-key' into 'main'

Add idempotency key

See merge request ypmn-public/php-api-client!8

Author: payuru

src/ApiRequest.php

@@ -53,12 +53,34 @@ class ApiRequest implements ApiRequestInterface
     /** @var string Хост для отправки запросов */
     private string $host = self::HOST;
 
+    /** @var string Ключ идемпотентности */
+    private string $idempotencyKey;
+
     /** @inheritdoc  */
     public function __construct(MerchantInterface $merchant)
     {
         $this->merchant = $merchant;
     }
 
+    /** @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');
+        }
+    }
+
+
     /** @inheritdoc  */
     public function getHost() : string
     {
@@ -343,6 +365,10 @@ public function sendPostRequest($data, string $api): array
             $this->addCurlOptHeaderFunction($setOptArray, $headers);
         }
 
+        if ($this->getIdempotencyKey()) {
+            $headers[] = 'X-Header-Idempotency-Key: ' . $this->getIdempotencyKey();
+        }
+
         curl_setopt_array($curl, $setOptArray);
 
         $response = curl_exec($curl);

src/ApiRequestInterface.php

@@ -128,6 +128,16 @@ public function sendReportGeneralRequest(array $params);
      */
     public function sendReportOrderRequest(array $params);
 
+    /** @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 array $params