Подключение к API
Внимание
API доступно только при активной подписки Professional или Business!
Главное про API
Для аутентификации в API используется HTTP-аутентификация типа Basic, где ключ API передается в качестве имени пользователя, а пароль оставляется пустым. То есть каждый запрос к API должен содержать обязательный заголовок Authorization вида:
Authorization: Basic <authKey>
Поле <authKey> в заголовке Authorization формируется путем base64-кодирования строки, составленной из ключа API и добавленного в конце двоеточия.
Примечание
Вы можете найти ключи API в вашем профиле на сайте Comsign.
GET-параметры
Для генерации вайта (предпросмотра или ZIP-архива) необходимо отправить HTTP GET-запрос на URL: https://api.comsign.io/v2, указав настройки для генерации в URL-параметрах.
Основные параметры для работы с API
Обязательно |
Параметр |
Для чего |
|---|---|---|
Да |
|
Выбор генератора:
sf – SafePage генератор.gp – GooglePage генератор.ms – MicrosoftPage генератор.ap – ApplePage генератор.as – AmazonPage генератор.wp – Word Press (HTML) генератор.wp&php=1 – Word Press (PHP) генератор.wp_cms – Word Press CMS генератор. |
Да |
|
Тема или URL для наполнения вайта контентом.
Для генераторов WordPress и SafePage необходимо прописать одну из доступных тем.
Для генераторов GooglePage, ApplePage, AmazonPage и MicrosoftPage используется URL-ссылка на приложение или товар (для генератора GooglePage также доступны темы).
Список доступных тем с кодами представлен ниже.
|
Да |
|
Выбор необходимого языка для перевода вайта. Прописывать в формате: язык_СТРАНА.
Список доступных языков с кодами представлен ниже.
|
Нет |
|
Обратная PHP-интеграция c клоакой Adspect.
Для активации необходимо подставить ключ stream_id из потока Adspect.
|
Нет |
|
Будет отдан ZIP-файл с вайтом. При активном параметре списывается лимит скачиваний.
Если параметра нет, то вместо файла будет отдано JPG превью.
|
Нет |
|
Номер генерации шаблона, случайный набор символов.
Если значение будет пустым, то
seed сформируется автоматически.Если значение не менять, то шаблон вайта сгенерируется повторно.
|
Дополнительные параметры для работы с API
Параметр |
Для чего |
|---|---|
|
Ключевые слова для интеграции в вайт, прописывать через запятую.
Пример: key, keyword1, keyword2
|
|
Доменное имя для интеграции в TOS&Privacy.
Пример: https://example.com или example.com
|
|
Название компании для интеграции в TOS&Privacy.
Пример: Stratton Oakmont Ltd.
|
|
Номер телефона для интеграции в TOS&Privacy.
Пример: +1 (800) 999-9999
|
|
Электронная почта для интеграции в TOS&Privacy.
Пример: support@example.com
|
|
Изменение заголовка вайта.
Пример: Example Title
|
|
Изменение названия index файла.
По умолчанию: index.html
Пример: page.html
|
|
Выбор формата расширения index файла
По умолчанию: .html
При использовании Adspect клоакинга: автоматически переключается на .php
|
|
Параметр позволяет размещать ссылки для переадресации с кнопок или формы.
Пример: https://exampleredirect.com
|
|
Параметр для переадресация с формы.
Для активации необходимо прописать: 1
|
|
Параметр для переадресация с кнопок.
Для активации необходимо прописать: 1
|
|
Параметр для размещения пикселя на странице вайта.
|
|
Параметр для размещения кода на страницу вайта в <head>.
|
|
Параметр для размещения кода на страницу вайта после <body>.
Пример: <div>example for body start<div>
|
|
Параметр для размещения кода на страницу вайта перед <body>.
Пример: <div>example for body end<div></div>
|
Важно
При вставке кода через параметры head, pixel, body_start или body_end необходимо использовать URL кодирование.
Пример релевантной URL-ссылки для работы с API:
https://api.comsign.io/v2?aid=2e2bbf52-adnc-5819-963c-8e0d48b26e9&keywords=example,keys&domain=example.com&lang=en_US&product=wp_v2&sid=3eb2a9d3-9k93-3etc-ci88-ac1f6f92a854&target=food&zip=true
Коды доступных языков
Язык |
Код |
|---|---|
Английский |
|
Арабский |
|
Армянский |
|
Азербайджанский |
|
Белорусский |
|
Бенгальский |
|
Болгарский |
|
Венгерский |
|
Вьетнамский |
|
Голландский |
|
Греческий |
|
Грузинский |
|
Датский |
|
Иврит |
|
Индонезийский |
|
Исландский |
|
Испанский |
|
Итальянский |
|
Ирландский |
|
Казахский |
|
Китайский |
|
Корейский |
|
Латышский |
|
Литовский |
|
Македонский |
|
Малайский |
|
Монгольский |
|
Немецкий |
|
Норвежский |
|
Польский |
|
Португальский |
|
Румынский |
|
Русский |
|
Сербский |
|
Словенский |
|
Тайский |
|
Турецкий |
|
Украинский |
|
Финский |
|
Французский |
|
Хинди |
|
Хорватский |
|
Чешский |
|
Шведский |
|
Эстонский |
|
Японский |
|
Коды доступных тем
Коды для WordPress и SafePage |
Коды для GooglePage |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|