Введение

В документации описан программный интерфейс сервиса Hitori (далее – «API»). Через API внешние приложения получают случайные тестовые данные: ФИО, контакты, ИНН, СНИЛС, логины, пароли и др.

Авторизация

Для того чтобы успешно взаимодействовать с API сервиса, необходимо получить токен доступа. Токен ― это специальный код, разрешающий доступ к использованию API конкретному пользователю. Подробная информация об авторизации и получению токена приведена на странице Токены.

Полученный токен, необходимо указывать в свойстве 'token' при каждом запросе к API.

Ограничения

Для снижения нагрузки на API установлены следующие квоты: до 50 строк за один запрос, до 1000 запросов в сутки.

Формат JSON

JSON (JavaScript Object Notation) – это текстовый формат представления данных в нотации объекта JavaScript. Несмотря на своё название, JSON можно использовать не только в JavaScript, но и в любом другом языке программирования.

JSON также обладает достаточно весомым преимуществом. В отличие от других форматов является более компактным, что очень важно при обмене данными. Также он более прост в использовании, легче читать и писать.

Во многих языках программирования существуют модули и библиотеки для работы с JSON. В документе содержатся примеры работы с JSON на языке JavaScript.

Запросы JSON

Запросы в формате JSON передаются методом HTTP POST на следующий адрес:

https://hit.ori.one/api
Структура входных данных

В случае предоставления входных данных, API учитывает только доступные ключи и их свойства. API игнорирует все остальные данные.


config = {
    'token': 'gd156j81D5ASs235fsdlk1',
    'gender': 'female',
    'count': 5,
    'param': ['FirstName', 'Email', 'DocINN']
}

Ключами и их свойствами можно ознакомиться в таблице Ключи и свойства

Ключи и свойства

Подробное описание ключей и их значений. При несуществующем значении применяется значение по умолчанию

Ключ Описание Возможные значения По умолчанию Обязательное свойство
token Специальный код доступа Обязательное свойство Ошибка – Код 100 Да
gender Пол male – мужской
female – женский
random – случайно
random Нет
сount Количество генераций Ограничения по квоте 1 Нет
param Поля для генерации Названия полей в массиве:
["FirstName", "Email", "INN"]
Все поля Нет
Доступные поля

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

ПараметрОписаниеОтвет
FirstNameИмяМаксим
LastNameФамилияБлоков
PatronymicОтчествоОстапович
DateOfBirthДата рождения05.04.1988
GenderПолМужской
CompanyКомпанияСтарком
VacancyДолжностьМаркетолог
BankNameБанкУРАЛСИБ
BankCardКарта5493037328601249
BankExpИстекает03/23
BankCVCCVС код006
LoginЛогинvalovitol
PasswordПарольiN8&#bz3
DocINNИНН физического лица488412126383
DocSNILSСНИЛС72753393521
AddressПолный адресг. Томск, Запрудная ул, д. 103, кв. 43
CityГородТомск
StreetУлицаЗапрудная
HouseНомер дома103
ApartmentКвартира43
PhoneНомер телефона+79560855471
EmailЭлектронная почтаvalovitol@mail.ru
WebsiteСайтvalovitol.com
CarBrandМарка автомобиляMercedes
CarModelМодель автомобиляSLK-class
CarYearГод выпуска2004
CarColorЦветОранжевый
CarNumНомерной знакKP511Y3
Формирование запроса

Пример демонстрирует сетевой запрос и получение информации от сервера при помощи вызова метода fetch().

fetch("https://hit.ori.one/api", {
    
    method: 'POST',
    
    body: JSON.stringify(config),
    
    headers: {'Content-Type': 'application/json'}
})


.then(response => response.json())

.then(result => console.log(result))

.catch(error => console.error('error', error));
Ответа от сервера

В случае успеха сервер возвращает код 200 OK с полями объекта в формате JSON в виде:

[{"FirstName":"Валерия","Email":"omskaeriya@bk.ru","DocINN":"785720928970"},{"FirstName":"Алуа","Email":"pyninua@mail.ru","DocINN":"317511875225"},{"FirstName":"Лика","Email":"uhovka@list.ru","DocINN":"327805850082"},{"FirstName":"Марианна","Email":"rentevaarianna@rambler.ru","DocINN":"339778599004"},{"FirstName":"Люся","Email":"aburinayusy@yahoo.com","DocINN":"115361247501"},{"Status-codes":[200]}]
Ошибки

Возвращаемые статусы ошибок и их значения.

КодТипОписание
100CriticalНеверный токен
101CriticalПревышен суточный лимит по квоте
200OKУспешно
301NotifyДля свойства 'gender' установлено значение по умолчанию
302NotifyДля свойства 'count' установлено значение по умолчанию
303NotifyДля свойства 'param' установлено значение по умолчанию
304SkipНеправильное название поля в массиве свойста 'param'

Дисклеймер

Все данные, отображаемые и генерируемые этим инструментом, являются случайными комбинациями фиктивных данных.

Любое сходство с реальными данными - всего лишь результат случайных алгоритмов.

Настоящие личные данные не используются. В системе нет личной информации пользователей.