В документации описан программный интерфейс сервиса Hitori (далее – «API»). Через API внешние приложения получают случайные тестовые данные: ФИО, контакты, ИНН, СНИЛС, логины, пароли и др.
Для того чтобы успешно взаимодействовать с API сервиса, необходимо получить токен доступа. Токен ― это специальный код, разрешающий доступ к использованию API конкретному пользователю. Подробная информация об авторизации и получению токена приведена на странице Токены.
Полученный токен, необходимо указывать в свойстве 'token' при каждом запросе к API.
Для снижения нагрузки на API установлены следующие квоты: до 50 строк за один запрос, до 1000 запросов в сутки.
JSON (JavaScript Object Notation) – это текстовый формат представления данных в нотации объекта JavaScript. Несмотря на своё название, JSON можно использовать не только в JavaScript, но и в любом другом языке программирования.
JSON также обладает достаточно весомым преимуществом. В отличие от других форматов является более компактным, что очень важно при обмене данными. Также он более прост в использовании, легче читать и писать.
Во многих языках программирования существуют модули и библиотеки для работы с JSON. В документе содержатся примеры работы с JSON на языке JavaScript.
Запросы в формате 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 |
BankCVC | CVС код | 006 |
Login | Логин | valovitol |
Password | Пароль | iN8bz3 |
DocINN | ИНН физического лица | 488412126383 |
DocSNILS | СНИЛС | 72753393521 |
Address | Полный адрес | г. Томск, Запрудная ул, д. 103, кв. 43 |
City | Город | Томск |
Street | Улица | Запрудная |
House | Номер дома | 103 |
Apartment | Квартира | 43 |
Phone | Номер телефона | +79560855471 |
Электронная почта | 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]}]
Возвращаемые статусы ошибок и их значения.
Код | Тип | Описание |
---|---|---|
100 | Critical | Неверный токен |
101 | Critical | Превышен суточный лимит по квоте |
200 | OK | Успешно |
301 | Notify | Для свойства 'gender' установлено значение по умолчанию |
302 | Notify | Для свойства 'count' установлено значение по умолчанию |
303 | Notify | Для свойства 'param' установлено значение по умолчанию |
304 | Skip | Неправильное название поля в массиве свойста 'param' |
Все данные, отображаемые и генерируемые этим инструментом, являются случайными комбинациями фиктивных данных.
Любое сходство с реальными данными - всего лишь результат случайных алгоритмов.
Настоящие личные данные не используются. В системе нет личной информации пользователей.