Jump to content

API

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

Адрес для запросов

Платные и бесплатные пользователи используют единую точку доступа для запросов:

GET or POST detective.dog/api

Бесплатный доступ могут получить некоммерческие проекты. Остальные пользователи оплачивают каждый запрос (минимальная сумма пополнения 5000 руб) к API.

Авторизация

Чтобы использовать API, нужно получить ключ, написав письмо на нашу почту api@detective.dog с указанием подробностей о своем проекте. Передавать ключ нужно в каждом запросе.

Имя Тип Описание
key string Ключ

Поиск животного по фото

GET detective.dog/api/core/search/image/lost


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

Имя Тип Описание
url string URL изображения (.png или .jpg)

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
count int Количество найденных животных
results int Информация о найденных животных

Поиск хозяина по фото

GET detective.dog/api/core/search/image/found


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

Имя Тип Описание
url string URL изображения (.png или .jpg)

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
count int Количество найденных животных
results int Информация о найденных животных

Поиск животного по параметрам

GET detective.dog/api/core/search/text/lost


Вы присылаете параметры поиска. Система вернет список подходящих по параметрам животных, которых кто-то потерял.

Имя Тип Описание
parameters array() Параметры животного для поиска

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
count int Количество найденных животных
results int Информация о найденных животных

Поиск хозяина по параметрам

GET detective.dog/api/core/search/text/found


Вы присылаете параметры поиска. Система вернет список подходящих по параметрам животных, которых кто-то нашел.

Имя Тип Описание
parameters array() Параметры животного для поиска

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
count int Количество найденных животных
results int Информация о найденных животных

Получить информацию о животном по ID

GET detective.dog/api/core/pets


Вы присылаете ID животного. Система вернет всю имеющуюся по нему информацию.

Имя Тип Описание
ID int ID животного

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
results int Информация о животном

Добавить животное в базу

GET detective.dog/api/core/pets/add


Вы присылаете известную информацию о животном. Система добавляет его в поисковый индекс, и оно становится доступно для поиска всем пользователям системы.

Имя Тип Описание
pet array Информация о животном

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
ID int ID добавленного животного

Удалить животное из базы

GET detective.dog/api/core/pets/remove


Вы присылаете ID животного. Система удаляет из поискового индекса информацию о животном с указанным ID, и оно не участвует в поиска.

Имя Тип Описание
ID int ID животного для удаления

Ответ:

Имя Тип Описание
status int 0 — ошибка или 1 — успешно
×
×
  • Create New...