engine | Life Is Porn

Содержание

1. Описание
   1. Обратная связь
2. Составление запросов
   1. GET-запросы
      1. Что это такое, и как этим пользоваться
      2. Адрес для обращений к нашему сервису
      3. Пример работы с нашим API
   2. POST-запросы
3. Получение ответа

Описание

Здесь мы расскажем как пользоваться нашим сервисом.

Обратная связь

Наша почта: support [сбчк] lifeis.porn.

Составление запросов

Запросы составляются на основе предлагаемого списка параметров каждого сервиса. Наш сервис работает с GET-запросами (в основном) и с POST-запросами (см. @TurniketSKUD_bot, @NearFood_bot и Помощь в пополнении баз).

GET-запросы

Что это такое, и как этим пользоваться

Чтобы сделать GET-запрос, нужно прости перейти на URL-адрес с выбранными параметрами.

Рассмотрим такой URL-адрес:

https://example.com/script.php?param1=value1&param2=value2

Всё, что находится после знака вопроса "?" - это GET-параметры. Если параметров несколько, они должны быть разделены символом амперсанда "&". Значения параметров указываются после знака равенства "=" без пробелов и кавычек (даже если нужно указать строку). В примере параметр "param1" равен "value1", а параметр "param2" равен "value2".

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

Рассмотрим адрес, на который посылается GET-запрос из примера:

https://example.com/script.php

"https://example.com" - адрес сайта, а "script.php" - скрипт, который будет обрабатывать запрос.

Адрес для обращений к нашему сервису

Мы предлагаем на выбор 2 адреса. Основной:

https://engine.lifeis.porn/api/<scriptname>

и зеркало (если вдруг предыдущий адрес блокируется семейными фильтрами или неприемлем по иным причинам):

https://lip2.xyz/api/<scriptname>

Вместо "<scriptname>" используйте название скрипта со страницы выбранного API.

Пример работы с нашим API

Для получения английского слова (см. Words) URL-адрес будет выглядеть следующим образом:

https://engine.lifeis.porn/api/words.php?eng

или зеркало:

https://lip2.xyz/api/words.php?eng

Здесь "words.php" - имя выбранного скрипта.

Параметр "eng" не имеет своего значения, поэтому указывается только сам параметр. В API слов значение параметра не проверяется, проверяется лишь его наличие. Но лучше указать значение "true".

Скопируйте получившийся URL-адрес в адресную строку браузера и перейдите на него. Результат будет представлен в виде JSON:

{
  "ok": true,
  "data":
    {
      "word": "gained",
      "explanation": "\u041f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u044b\u0439"
    },
  "amount": -1
}

Результат будет записан одной длинной строкой, но в этом примере мы сделали его нагляднее.

Символы кириллицы в JSON кодируются Unicode-кодами. После преобразования они вновь станут читаемыми.

Для ручной работы с результатами можно использовать сервис JSON Editor Online.

Другой пример. Для получения двух лёгких вопросов с ответами (см. Millionaire) готовый URL-адрес будет выглядеть следующим образом:

https://engine.lifeis.porn/api/millionaire.php?qType=1&count=2

или зеркало:

https://lip2.xyz/api/millionaire.php?qType=1&count=2

Результат:

{
  "ok": true,
  "data": 
    [
      {
        "question": "Какое царство чаще всего упоминается в русских сказках?",
        "answers": 
          [
            "Тридевятое",
            "Тришестое",
            "Триседьмое",
            "Тривосьмое"
          ],
        "id": 0
      },
      {
        "question": "Чему в пословице не даёт покоя дурная голова?",
        "answers": 
          [
            "Ногам",
            "Спине",
            "Глазам",
            "Волосам"
          ],
        "id": 0
      }
    ],
  "amount": -1
}

Этот результат мы показали в кодировке UTF-8.

POST-запросы

Адреса для POST-запросов те же, что и для GET-запросов. Мы работаем с типом отправляемого контента "application/json". Описание структуры для JSON имеется на страницах тех API, которые его поддерживают (или на странице пополнения баз).

Получение ответа

Как было описано выше, наш сервис возвращает данные в формате JSON, при этом могут быть возвращены некоторые коды ошибок в случае с неверным API-ключом, нулевым балансом (см. Коды ошибок при использовании API-ключа) или неверными параметрами (или их значениями) ("400 Bad Request").