API перевірки email

GET

API перевірки email

curl --request GET \
  --url https://emailvalidation.cleariflow.com/v1

import requests

url = "https://emailvalidation.cleariflow.com/v1"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://emailvalidation.cleariflow.com/v1', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://emailvalidation.cleariflow.com/v1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://emailvalidation.cleariflow.com/v1"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://emailvalidation.cleariflow.com/v1")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://emailvalidation.cleariflow.com/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

Швидкий старт

Щоб виконати запит, передайте унікальний api_key і email, який потрібно перевірити — більше нічого не потрібно:

https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = jane.doe@acme-corp.com

Запит виконується успішно і повертає всі доступні дані про адресу:

{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

Параметри запиту

string

обов'язково

Ваш особистий API-ключ. Ключі прив’язані до конкретного продукту Cleariflow, тому ключ Email Validation не авторизує запити, наприклад, до API геолокації IP.

String

обов'язково

Email-адреса, яку потрібно перевірити.

Boolean

Необов’язковий прапорець для вимкнення автокорекції. Встановіть auto_correct=false, щоб вимкнути її. За замовчуванням увімкнено.

Параметри відповіді

Відповіді повертаються у компактному, стандартизованому форматі JSON.

String

Повторює email, переданий у запиті.

String

Запропонована корекція, якщо виявлено ймовірну помилку (наприклад, johnsmith@gmial.com => johnsmith@gmail.com). Порожньо, якщо пропозиції немає.

String

Оцінка Cleariflow щодо можливості доставки листів на цю адресу. Можливі значення: DELIVERABLE, UNDELIVERABLE, UNKNOWN. DELIVERABLE вимагає успішної SMTP-перевірки; якщо MX-записи є, але SMTP не підтвердив скриньку (часто у великих провайдерів), результат UNKNOWN. На всіх планах виконуються однакові перевірки; безкоштовні відрізняються лише місячною квотою та лімітом RPS (див. коди помилок 422 і 429).

Float

Десятковий бал від 0 до 0.99, що відображає якість адреси. Disposable-адреси обмежені близько 0.05; без підтвердження SMTP — максимум 0.55.

Boolean

true, якщо адреса відповідає стандартному шаблону local@domain.tld. Відсутні елементи або недопустимі символи дають false.

Boolean

true, якщо домен належить безкоштовному email-провайдеру (наприклад, Gmail, Yahoo).

Boolean

true, якщо домен є у нашому списку одноразових/тимчасових поштових сервісів (наприклад, Mailinator, Yopmail).

Boolean

true, якщо локальна частина схожа на рольовий акаунт, а не на особисту адресу, наприклад team@, sales@, info@.

Boolean

true, якщо домен налаштовано як catch‑all.

Boolean

true, якщо для домену існують MX-записи.

Boolean

true, якщо SMTP-перевірка успішна. Якщо SMTP не пройшов, але інші перевірки пройшли, результат може бути UNKNOWN. Ми не рекомендуємо блокувати реєстрації або відправку форм лише через помилки SMTP.

Приклади запитів

Приклад: ймовірна помилка в написанні

Цей приклад демонструє запит, у якому виявлено ймовірну помилку в переданій адресі. Навіть якщо знайдено ймовірну помилку, усі інші перевірки (наприклад, безкоштовний email, одноразовий домен) виконуються для оригінально переданої адреси — а не для запропонованої корекції.

https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = johnsmith@gmial.con

Успішна відповідь виглядає так:

{
  "email": "johnsmith@gmial.con",
  "autocorrect": "johnsmith@gmail.com",
  "deliverability": "UNKNOWN",
  "quality_score": 0.4,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": false,
    "text": "FALSE"
  },
  "is_smtp_valid": {
    "value": false,
    "text": "FALSE"
  }
}

Приклад: недійсний формат

Цей приклад демонструє адресу, яка не проходить базову перевірку формату. Коли is_valid_format дорівнює false, наступні перевірки (наприклад, is_free_email, is_role_email) пропускаються і повідомляються як false.

https://emailvalidation.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& email = johnsmith

Успішна відповідь виглядає так:

{
  "email": "johnsmith",
  "autocorrect": "",
  "deliverability": "UNDELIVERABLE",
  "quality_score": 0.0,
  "is_valid_format": {
    "value": false,
    "text": "FALSE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": false,
    "text": "FALSE"
  },
  "is_smtp_valid": {
    "value": false,
    "text": "FALSE"
  }
}

Масове завантаження (CSV)

Не хочете викликати API напряму? Скористайтеся масовим завантаженням CSV — результати будуть надіслані вам на email після завершення обробки. При завантаженні CSV дотримуйтесь цих правил:

Розмістіть email-адреси в першому стовпці.
Видаліть порожні рядки.
Використовуйте одну адресу на рядок.
Обмежте файли максимум 50 000 рядками.

Коди відповідей і помилок

Помилки повертаються у форматі JSON з кодом і зрозумілим описом. Поширені коди наведено нижче.

Code	Type	Details
200	OK	Запит успішно виконано.
400	Bad request	Некоректний або недійсний запит.
401	Unauthorized	Помилка автентифікації — зазвичай через відсутній або недійсний API-ключ.
422	Quota reached	Квоту вичерпано (наприклад, недостатньо кредитів на безкоштовних тарифах).
429	Too many requests	Перевищено ліміт запитів (на безкоштовних тарифах — до 1 запиту/сек).
500	Internal server error	Несподівана помилка на нашому боці.
503	Service unavailable	Сервіс тимчасово недоступний.

Інші примітки

Примітка щодо тарифів: на всіх планах (безкоштовних і платних) виконуються однакові перевірки, включно з MX, SMTP і catch-all. Примітка щодо тарифікації: кожна перевірена email-адреса списує один кредит за запит — незалежно від результату. Надсилання недійсної адреси (наприклад, «fda3346ds») все одно зараховується як один кредит.

API перевірки телефонних номерівШвидкий RESTful JSON API Cleariflow для структурної перевірки телефонних номерів, нормалізації E.164 та опційних даних про оператора, місцезнаходження, часовий пояс і дзвінок.

Наступна

API перевірки email

curl --request GET \
  --url https://emailvalidation.cleariflow.com/v1

import requests

url = "https://emailvalidation.cleariflow.com/v1"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://emailvalidation.cleariflow.com/v1', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://emailvalidation.cleariflow.com/v1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://emailvalidation.cleariflow.com/v1"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://emailvalidation.cleariflow.com/v1")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://emailvalidation.cleariflow.com/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "email": "jane.doe@acme-corp.com",
  "autocorrect": "",
  "deliverability": "DELIVERABLE",
  "quality_score": 0.85,
  "is_valid_format": {
    "value": true,
    "text": "TRUE"
  },
  "is_free_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_disposable_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_role_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_catchall_email": {
    "value": false,
    "text": "FALSE"
  },
  "is_mx_found": {
    "value": true,
    "text": "TRUE"
  },
  "is_smtp_valid": {
    "value": true,
    "text": "TRUE"
  }
}

Валідація

Пошук

Створення

API перевірки email

Швидкий старт

Параметри запиту

Параметри відповіді

Приклади запитів

Приклад: ймовірна помилка в написанні

Приклад: недійсний формат

Масове завантаження (CSV)

Коди відповідей і помилок

Інші примітки

​Швидкий старт

​Параметри запиту

​Параметри відповіді

​Приклади запитів

​Приклад: ймовірна помилка в написанні

​Приклад: недійсний формат

​Масове завантаження (CSV)

​Коди відповідей і помилок

​Інші примітки

Швидкий старт

Параметри запиту

Параметри відповіді

Приклади запитів

Приклад: ймовірна помилка в написанні

Приклад: недійсний формат

Масове завантаження (CSV)

Коди відповідей і помилок

Інші примітки