> For the complete documentation index, see [llms.txt](https://docs.iexexchanger.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iexexchanger.com/get-started/exchanger-api/kak-ustroen-api/hmac-signature.md).

# HMAC-подпись запросов

HMAC нужна, чтобы API мог проверить, что запрос действительно отправил владелец ключа и что body/query не изменились по дороге.

## Когда нужна HMAC

HMAC может быть обязательной:

* для всех приватных запросов;
* только для write-запросов: `POST`, `PUT`, `PATCH`, `DELETE`;
* для конкретного API-ключа.

Если HMAC нужна, но headers не переданы, API вернет `signature_required`.

## Headers HMAC-подписи

```http
X-Api-Timestamp: 1782190000
X-Api-Nonce: req-20260623-001
X-Api-Signature: sha256=...
```

| Header              | Что передавать                        |
| ------------------- | ------------------------------------- |
| `X-Api-Timestamp`   | Unix timestamp или ISO-8601 время.    |
| `X-Api-Nonce`       | Уникальная строка для одного запроса. |
| `X-Api-Signature`   | HMAC-SHA256 подпись.                  |
| `X-Api-File-Sha256` | SHA-256 файла для multipart upload.   |

## Строка для подписи

Подписывается такая строка:

```
v1
METHOD
/api/v3/path
canonical_query
sha256_body
timestamp
nonce
```

Пример для GET:

```
v1
GET
/api/v3/private/exchange/routes
filter%5Bfrom_currency_id%5D=1&filter%5Bto_currency_id%5D=2
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
1782190000
req-20260623-001
```

Пример для JSON POST:

```
v1
POST
/api/v3/private/exchange/quotes

SHA256_OF_EXACT_JSON_BODY
1782190000
req-20260623-002
```

Пустой query остается пустой строкой.

## PHP пример

В репозитории есть helper `sdk/php/PublicApiSigner.php`.

```php
$body = PublicApiSigner::jsonBody([
    'route_id' => 25,
    'amount' => '100',
]);

$headers = PublicApiSigner::headers(
    method: 'POST',
    path: '/api/v3/private/exchange/quotes',
    hmacSecret: $hmacSecret,
    body: $body,
);
```

Важно: отправляйте ровно тот `$body`, который подписали.

## Multipart upload

Для upload файла не подписывайте весь multipart body. Подписывайте SHA-256 самого файла:

```bash
FILE_SHA=$(sha256sum passport.jpg | awk '{print $1}')
```

Передайте:

```http
X-Api-File-Sha256: FILE_SHA
```

## Частые причины `invalid_signature`

* В подписи забыли `/api/v3`.
* Подписали один JSON, а отправили другой.
* Query parameters отсортированы не так.
* Время сервера сильно отличается.
* Nonce уже использовался.
* Перепутали API HMAC secret и webhook secret.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.iexexchanger.com/get-started/exchanger-api/kak-ustroen-api/hmac-signature.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.