Начало работы
TheCatAPI — это REST API с данными о породах, изображениями и анализом фотографий для приложений о питомцах. С его помощью можно создавать профили питомцев, проверки здоровья и контент о породах для владельцев или добавить данные о породах в продукт для страхования, ветеринарии или кормов.
1. Получите API-ключ
Зарегистрируйтесь, и мы пришлём ключ на почту. Передавайте его в заголовке x-api-key в каждом запросе. Подробнее — в разделе Авторизация, а Тестовые и рабочие аккаунты объясняют, как тестировать, не затрагивая реальные данные.
2. Отправьте первый запрос
curl -H "x-api-key: YOUR-API-KEY" https://api.thecatapi.com/v1/breeds/abys
{
"id": "abys",
"name": "Abyssinian",
…
}
Все эндпоинты находятся по адресу https://api.thecatapi.com/v1. Если что-то пошло не так, раздел Ошибки и лимиты объясняет каждый код ответа и когда стоит повторить запрос.
3. Выберите, что вы создаёте
| Вам нужно… | Начните с |
|---|---|
| Показать сведения о породе, факты и советы по здоровью | Данные о породах для контента |
| Искать изображения кошек или дать пользователям загружать свои | Изображения и Загрузка изображений |
| Дать каждому владельцу профиль питомца | Создание питомца, затем Связь питомцев с пользователями |
| Определить породу, возраст или вес по фото | Определение породы, Оценка возраста, Оценка веса |
| Оценить упитанность с проверкой ветеринара | Оценка упитанности |
| Рекомендовать суточную калорийность или план снижения веса | Суточная калорийность и План снижения веса |
| Вести историю здоровья | История здоровья питомца |
| Получать результаты на свой сервер | Вебхуки |
Обзор руководств содержит их полный список. Справочник API описывает каждый эндпоинт и поле.
Тарифы
Тариф Free подходит для обучения и личных проектов. Тариф Startup добавляет коммерческую лицензию, более высокие лимиты запросов и полный набор данных о породах за небольшую ежемесячную плату. Тарифы Enterprise открывают анализ фотографий, медицинские записи и калькуляторы.
Характеристики пород (темперамент, происхождение, продолжительность жизни, шерсть и оценки качеств от 1 до 5) и факты входят в Startup. Советы по здоровью, риски и рекомендации по питанию, аллергены, рекомендации по уходу и активности, шутки, анализ фотографий и портреты доступны в Enterprise.
Чтобы узнать, что включено для вашего ключа, вызовите GET /accounts/features или прочитайте Что включено. Свяжитесь с нами, чтобы обсудить доступ к Enterprise и цены.