Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 3.97 KB

README.md

File metadata and controls

79 lines (54 loc) · 3.97 KB

DEADSOUL

API для создания случайных пользовательских профилей

Краткая справка:

Как использовать?

Вы можете использовать AJAX или любой другой досупный вам метод для получения результата. Например, запрос на создание 1 случайного пользователя, выполненный на JQuery, выглядит так:

$.get("http://host/api/",function (json){
  console.log(json);
}, "json");

Как выглядит результат?

Ниже вы можете видеть результат запроса, возвращенный в формате JSON. На данный момент доступны следующие форматы: JSON, SQL и XML. Вы можете указать формат возвращаемых данных при помощи параметра format Форматом по умолчанию является JSON.

[
 {
    "age": 23,
    "birthdate": "24.08.1991",
    "gender": "male",
    "name": {
        "last": "Горенский",
        "first": "Кирилл",
        "full": "Горенский Кирилл"
    },
    "city": "Невинномысск",
    "phone": "+7(932) 2463297",
    "email": "[email protected]",
    "nickname": "kirill.gorenskij91",
    "password": "14829f",
    "avatar": "http:\/\/www.gravatar.com\/avatar\/e0f23ab00550960ec86011a13b4bb8c8?s=128&d=identicon&r=g",
    "socialID": "704-500-950 57",
    "md5": "3f61ce6303bce448defbf02b7f88ea34"
 }
]

Как получить несколько пользователей?

Для получения списка пользователей используйте параметр count. Учтите, что максимальное значение этого параметра - 100. Все значения, превышающие это ограничение, будут обрезаны до 100. Значение по-умолчанию: count = 1. Так-же имейте ввиду, что при count = 1, результат в формате JSON - это массив из одного элемента: user.nickname = json[0].nickname Пример использования count:

http://host/api/?count=5

Как указать требуемый пол?

Если вам необходимы пользователи определенного пола, вы можете сделаить это при помощи параметра gender. Данный параметр принимает 3 значения :

a   Выборка содержит как мужчин, так и женщин. Это значение по-умолчанию;
m   Выборка содержит только мужчин;
f   Выборка содержит только женщин;

Пример использования gender:

$.get("http://dsoul.controlcash.ru/api/?gender=a",function (json){
  console.log(json);
}, "json");

Как ограничить возраст?

Для получения определенной возрастной группы необходимо указать параметр age_range. Возрастные рамки задаются в виде строки 'minAGE-maxAGE', где minAGE>=16, а maxAGE<=60 Данный параметр имеет смысл при использовании совместно с count:

http://host/api/?count=5&age_range=20-30

Как выбрать формат ответа?

Выбор параметра format позволяет указать тип выходных данных. На данный момент доступны JSON, SQL, XML. По умолчанию данные отдаются в формате JSON.

http://host/api/?format=sql