Документация по API сайта search4faces.com


Работа с Search4faces API построена на архитектуре JSON-RPC 2.0.

Запрос обязательно должен содержать следующие HTTP-заголовки:

Content-Type: application/json

x-authorization-token: ваш_API_ключ

URL для отправки запросов:

https://search4faces.com/api/json-rpc/v1

Если вы хотите бесплатно попробовать подключение по API напишите нам на почту и мы вам вышлем тестовый ключ. Примеры кода доступны на PHP и Python.


rateLimit

Проверка текущих ограничений для вашего ключа.

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

{
  "jsonrpc": "2.0",
  "method": "rateLimit",
  "id": "some-id",
  "params": {}
}

Метод не имеет параметров.

Результат успешного выполнения:

{
  "jsonrpc": "2.0",
  "result": {
    "apikey": "5c40b9-b246ab-648561-435157-2c3f8b",
    "limit": 10000,
    "remaining": 9954,
    "speed": 8,
    "allowed": [
      "rateLimit",
      "detectFaces",
      "searchFace"
    ],
    "disabled": "no"
  },
  "id": "some-id"
}

Поля возвращаемого объекта:

apikey (str) - используемый вами ключ
limit (int) - запросов предоставлено
remaining (int) - неиспользованных запросов
speed (int) - запросов в минуту, не более
allowed (array[str]) - список доступных методов
disabled (bool) - текущий статус ключа
detectFaces

Обнаружение лиц на изображении.

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

{
  "jsonrpc": "2.0",
  "method": "detectFaces",
  "id": "some-id",
  "params": {
    "image": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAP/wgALCAABAAEBAREA/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPxA="
  }
}

Параметры:

image (str) - исходное jpeg или png изображение кодированное в текст (base64)

Результат успешного выполнения:

{
  "jsonrpc": "2.0",
  "result": {
    "image": "5eb16c3421dd32.08349177.jpg",
    "faces": [
      {
        "x": 25,
        "y": 37,
        "width": 55,
        "height": 67,
        "lm1_x": 39,
        "lm1_y": 68,
        "lm2_x": 62,
        "lm2_y": 62,
        "lm3_x": 53,
        "lm3_y": 80,
        "lm4_x": 47,
        "lm4_y": 90,
        "lm5_x": 67,
        "lm5_y": 84
      },
      {...}
    ]
  },
  "id": "some-id"
}

Поля возвращаемого объекта:

image (str) - идентификатор изображения для передачи в метод searchFace
faces (array[obj]) - массив c координатами найденных лиц
  x (int) - координата x прямоугольника ограничивающего лицо
  y (int) - координата y прямоугольника ограничивающего лицо
  width (int) - ширина прямоугольника ограничивающего лицо
  height (int) - высота прямоугольника ограничивающего лицо
  lm1_x (int) - координата x левого глаза
  lm1_y (int) - координата y левого глаза
  lm2_x (int) - координата x правого глаза
  lm2_y (int) - координата y правого глаза
  lm3_x (int) - координата x кончика носа
  lm3_y (int) - координата y кончика носа
  lm4_x (int) - координата x левого уголка губ
  lm4_y (int) - координата y левого уголка губ
  lm5_x (int) - координата x правого уголка губ
  lm5_y (int) - координата y правого уголка губ
searchFace

Поиск похожих лиц в соцсетях.

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

{
  "jsonrpc": "2.0",
  "method": "searchFace",
  "id": "some-id",
  "params": {
    "image": "5eb16c3421dd32.08349177.jpg",
    "face": {
      "x": 25,
      "y": 37,
      "width": 55,
      "height": 67,
      "lm1_x": 39,
      "lm1_y": 68,
      "lm2_x": 62,
      "lm2_y": 62,
      "lm3_x": 53,
      "lm3_y": 80,
      "lm4_x": 47,
      "lm4_y": 90,
      "lm5_x": 67,
      "lm5_y": 84
    },
    "source": "vk_wall",
    "hidden": true,
    "results": "10"
  }
}

Параметры:

image (str) - идентификатор изображения, полученный в методе detectFaces
face (obj) - координаты лица, например, полученные в методе detectFaces
  x (int) - координата x прямоугольника ограничивающего лицо
  y (int) - координата y прямоугольника ограничивающего лицо
  width (int) - ширина прямоугольника ограничивающего лицо
  height (int) - высота прямоугольника ограничивающего лицо
  lm1_x (int) - координата x левого глаза
  lm1_y (int) - координата y левого глаза
  lm2_x (int) - координата x правого глаза
  lm2_y (int) - координата y правого глаза
  lm3_x (int) - координата x кончика носа
  lm3_y (int) - координата y кончика носа
  lm4_x (int) - координата x левого уголка губ
  lm4_y (int) - координата y левого уголка губ
  lm5_x (int) - координата x правого уголка губ
  lm5_y (int) - координата y правого уголка губ
source (str) - vkok_avatar или vk_wall или tt_avatar или ch_avatar (база данных для поиска)
hidden (bool) - показывать в дополнение к общей выдаче также и скрытые профили
results (int) - максимальное количество выдаваемых профилей, не более 500

Результат успешного выполнения:

{
  "jsonrpc": "2.0",
  "result": {
    "profiles": [
      {
        "score": "94.70",
        "face": "https://search4faces.com/faces/vk01/00/00/00/7/0.jpg",
        "profile": "https://vk.com/id1",
        "photo": "https://vk.com/id1?z=photo1_288668576%2Fphotos1",
        "photo_x": 368,
        "photo_y": 265,
        "photo_width": 146,
        "photo_height": 174,
        "source": "https://sun9-3.userapi.com/c7003/v7003978/1ed9/yoeGXOWmW-M.jpg",
        "age": 35,
        "first_name": "Павел",
        "last_name": "Дуров",
        "maiden_name": "",
        "city": "Санкт-Петербург",
        "country": "Россия"
      },
      {...}
    ]
  },
  "id": "some-id"
}

Поля возвращаемого объекта:

profiles (array[obj]) - массив c найденными профилями пользователей
  score (float) - процент схожести
  face (str) - адрес изображения лица сохранённое на сервере search4faces
  profile (str) - адрес профиля пользователя
  photo (str) - адрес страницы с изображением из профиля
  photo_x (int) - координата x прямоугольника ограничивающего лицо
  photo_y (int) - координата y прямоугольника ограничивающего лицо
  photo_width (int) - ширина прямоугольника ограничивающего лицо
  photo_height (int) - высота прямоугольника ограничивающего лицо
  source (str) - адрес исходного изображения из профиля
  age (int) - возраст указанный в профиле
  first_name (str) - имя указанное в профиле
  last_name (str) - фамилия указанная в профиле
  maiden_name (str) - отчество указанное в профиле
  city (str) - город проживания указанный в профиле
  country (str) - строна проживания указанная в профиле

Тарифы АПИ


5000
15000
45000
135000