Использование API сервиса "Идеи для фотографии"

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

Условия использования API сервиса просты:

- работа API предоставляется полностью бесплатно;
- возможности API предоставляется AS IS (как есть);
- запрещается вмешиваться в работу API;
- запрещается создавать избыточную нагрузку на сервера;
- по возможности мы просим указывать ссылку на сайт или логотип сервиса;
- мы всегда открыты для ваших предложений.

Для общения к API предусмотрено два типа запросов text и json.

Запрос типа text в сочетании с ключом, выдает в текстовом виде один из всех имеющихся вариантов идей.

Пример: https://photosession.tips/api/api.php?type=text&key=APIKEY
Ответ: результат в виде случайной выборки из общего списка идей.

Запрос типа json в сочетании с ключом, выдает один из имеющихся вариантов идей в формате JSON.

Пример: https://photosession.tips/api/api.php?type=json&key=APIKEY
Ответ: результат в виде случайной выборки из общего списка идей с дополнительными данными.

В результате запроса возвращаются следующие параметры: status,idi,message,count_img,image_src,s,api,count_r,ps_logo

Тест (нажмите для демонстрации)
Запрос: https://photosession.tips/api/api.php?type=json&key=APIKEY

Параметр Описание Результат Пример
status статус запроса -
idi id номер идеи -
message идея из базы
count_img счётчик выполнений
image_src путь до картинки примера
s технический параметр -
api ключ API из запроса -
count_r счетчик обращений по ключу API -
ps_logo логотип сервиса в.svg


В зависимости от результата обработки запроса, API может вернуть следующие коды состояний:

Код: 200 запрос прошел успешно
Код: 400 неверные входные данные (формат, номер)
Код: 403 превышен лимит запросов или IP заблокирован
Код: 500 ошибка сервера


Если при обращению к API сервиса не был указан корректный тип запроса, например отличный от имеющихся вариантов "json или text", а так же указан неверный или несуществующий ключ API, система вернет в ответ код "400" без выполнения запроса.



Пример подключения API к вашему сайту:

Подключаем библиотеку jquery:

<script   src="https://code.jquery.com/jquery-3.4.1.min.js"  integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="  crossorigin="anonymous"></script>

Используя код на Jquery делаем JSON запрос:

<script type="text/javascript">$("#test").on("click",function() {
        var url = 'https://photosession.tips/api/api.php?';
        var type = 'json';
        var key = 'APIKEY';
        dataString = 'type='+encodeURIComponent(type)+'&key='+encodeURIComponent(key);
  $.getJSON(url + dataString +'&callback=?', function(json) {
        $("#response_text_d").html(json.message);
        $("#response_image").attr("src",json.image_src);
        $("#response_count").html(json.count_img);
        $("#response_logo").attr("src",json.ps_logo);
   });
        return false;
});
</script>

Пояснения примера:

'json'; - указываем тип запроса JSON
'APIKEY'; - APIKEY необходимо заменить на ваш ключ API


$("#response_text_d").html(json.message); - будет выведен в ID блока #response_text_d параметр "message".
Будет выведен текст с идеей в <div id="response_text_d">

$("#response_image").attr("src",json.image_src); - будет заменено значение src изображения, параметром "image_src"


Внимание API сервиса работает в тестовом режиме. Могут наблюдаться некоторые проблемы в работе.

Android App's

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