Кодекс · III

API-ключи

API-ключи позволяют вызывать конечные точки оформления заказа и статуса из собственного кода без кнопки покупки. Он вам нужен только, если вы создаёте собственное оформление заказа или интеграцию сервера; если вы вставляете кнопку покупки, вы можете совсем это пропустить.

Когда вам нужен ключ

Кнопка покупки работает вообще без ключа — она общается с общественными конечными точками, ограниченными проектом. Ключ нужен для другого пути: вызовов, которые вы делаете с вашего собственного сервера, где вы создаёте оформление заказа или читаете статус транзакции в коде. Ключи находятся на вкладке API-ключи вашего проекта.

Вкладка «API-ключи». Пусто, пока вы не создадите свой первый ключ.

Создание ключа

Нажмите Создать ключ, дайте ему имя, которое вы узнаете позже — обычно где он работает, например «Сервер производства» — и нажмите Создать ключ. Имя — это только метка для вас; оно не изменяет то, что может делать ключ (ключ привязан к этому проекту).

Назовите ключ по месту его расположения, затем создайте его.

Скопируйте его один раз

Ключ отображается один раз, сразу после его создания. Он начинается с cmk_. Скопируйте его сейчас и сохраните где-нибудь в безопасности — мы храним только хеш, поэтому мы не можем показать его вам снова. Потеряйте его, и вы просто создаёте новый и удаляете старый.

Это единственный раз, когда полный ключ показан. Скопируйте его перед закрытием.

Относитесь к ключу как к паролю. Используйте его только из кода на стороне сервера, отправляйте его в заголовке Authorization как токен-носитель и никогда не помещайте его на веб-страницу, в общедоступный репозиторий или что-либо, что отправляется в браузер покупателя. Любой, у кого есть ключ, может действовать от имени вашего проекта.

Использование, перечисление и отзыв

Сохранённые ключи отображаются по имени, замаскированному префиксу и дате создания. Вы больше никогда не видите полный ключ — префикс — это просто достаточно, чтобы их различать. Значок корзины отзывает ключ немедленно: любой код, всё ещё использующий его, начинает получать отказ, поэтому ротируйте, сначала создав новый ключ, развернув его, затем удалив старый.

Каждый ключ показывает замаскированный префикс и дату создания; значок корзины отзывает его.

Для того, что вы можете вызвать с помощью ключа — создание оформления заказа из вашего собственного кода, обработку событий и опрос статуса — смотрите Использование API.

Готовы всё подключить?

Бесплатный тариф покрывает большинство сайтов и никогда не просит карту.