Emailook API

Вы можете использовать API сервиса для интеграции его в ваш пайплайн или приложение. Если вы нашли ошибку или у вас есть вопросы при использовании API, не стесняйтесь обращаться к нам за помощью.

Аутентификация и ограничения

Аутентификация происходит с помощью токена API, скопировать его можно на странице профиля. Основное ограничение — 1 запрос в секунду, остальные ограничения указаны на странице тарифов. При превышении лимита возвращается предупреждение с кодом ответа 429.

Отправка запроса

Сейчас вы можете получить полный вывод проверки в формате JSON, используя следующие данные:

Эндпоинт: https://emailook.ru/api

Метод: POST

Нагрузка: Код письма в кодировке UTF-8

Заголовки: API-TOKEN: {ваш api токен}

Заголовки: REQ-TYPE: {json или html}

Заголовки: Content-Type: text/plain

Пример запроса

curl -G https://emailook.ru/api \

-H 'API-TOKEN: {ваш api токен}'

-H 'REQ-TYPE: {json или html}'

-H 'Content-Type: text/plain'

-d '{HTML-код письма}'

Разбор ответа JSON

Ответ содержит 4 группы:

urls Содержит список ссылок.

emails Содержит список емейлов.

phones Содержит список телефонов.

texts Содержит список текстов.

В каждой группе содержатся параметры. Общие параметры:

line_number Строка элемента.

error_level Уровень ошибки. 3 — ошибка есть, 2 — рекомендуется ручная проверка, 1 — ошибок нет.

status_message Текстовое сопровождение ошибки.

Параметры для urls

url_full Полный URL, включая все параметры.

url_clean URL без параметров.

url_utm_* UTM метки из URL.

url_params Все параметры из URL, кроме UTM.

url_type Тип URL. url — обычная ссылка, img — изображение, css — CSS файл, font — шрифт.

Параметры для emails

email_in_code Емейл в коде письма.

email_in_text Емейл в тексте письма.

Параметры для phones

phone_in_code Телефон в коде письма.

phone_in_text Телефон в тексте письма.

Параметры для texts

text Текст.

error_messages Список с ошибками, дпущенными в тексте.

word Слово с ошибкой.

suggestions Список слов для замены.

Параметры вне групп:

code_size_in_kb Размер кода письма в килобайтах.

app_version Версия сервиса.

limits Лимиты — количество оставшихся запросов.

Пример ответа

{
    "urls": [
        {
            "line_number": 8,
            "error_level": 3,
            "status_message": "Ошибка при загрузке страницы.",
            "url_full": "https://google.com/hello?t=t&m=param&utm_source=source&utm_medium=medium&utm_campaign=campaign&utm_content=content&utm_term=term",
            "url_clean": "https://google.com/hello",
            "url_utm_source": "source",
            "url_utm_medium": "medium",
            "url_utm_campaign": "campaign",
            "url_utm_content": "content",
            "url_utm_term": "term",
            "url_params": "t=t&m=param&",
            "url_type": "url"
        },
        // ...
    ],
    "emails": [
        {
            "line_number": 30,
            "error_level": 1,
            "status_message": "Ошибок нет.",
            "email_in_code": "hi@nikitahsvsov.com",
            "email_in_text": "hi@nikitahsvsov.com"
        },
       // ...
    ],
    "phones": [
        {
            "line_number": 24,
            "error_level": 1,
            "status_message": "Ошибок нет.",
            "phone_in_code": "89150021613",
            "phone_in_text": "89150021613"
        },
       // ...
    ],
    "texts": [
            {
            "line_number": 10,
            "error_level": 3,
            "status_message": "Есть ошибки.",
            "text": "Текст с ашибкой, ещё премер и таг далие.",
            "error_messages": [
                {
                    "word": "ашибкой",
                    "suggestions": [
                        "ошибкой"
                    ]
                },
                {
                    "word": "премер",
                    "suggestions": [
                        "пример",
                        "премьер"
                    ]
                },
                {
                    "word": "таг",
                    "suggestions": [
                        "так"
                    ]
                },
                {
                    "word": "далие",
                    "suggestions": [
                        "далее"
                    ]
                }
            ]
        },
        {
            "line_number": 13,
            "error_level": 1,
            "status_message": "Ошибок нет.",
            "text": "А тут",
            "error_messages": []
        },
       // ...
    ],
    "code_size_in_kb": 3.4,
    "app_version": "0.3.4",
    "limits": "Осталось запросов: 0/с 4/м 14/ч 13/д"
}