Репозиторий public-apis/public-apis представляет собой каталог общедоступных API, поддерживаемый сообществом. Public APIs каталог бесплатных API помогает просматривать категории, читать поля таблицы и решать, что нужно проверить перед интеграцией. Это отправной указатель. Он не гарантирует, что каждая запись доступна, навсегда бесплатна, легальна для любого использования или подходит для применения в реальных условиях.
Начните с указателя категорий
Откройте официальный репозиторий и используйте указатель в README, чтобы перейти к таким темам, как животные, аутентификация и авторизация, финансы, геокодирование, государственные данные, открытые данные, программирование и погода. Категория помогает сузить поиск. Она не заменяет документацию поставщика.
Строки репозитория обычно содержат шесть полей:
Поле | Как его читать |
|---|---|
API | Название со ссылкой на документацию или сервис |
Описание | Краткое описание, предоставленное репозиторием |
Аутентификация | Метка, например |
HTTPS | Сведения репозитория о поддержке HTTPS |
CORS | Сведения репозитория о поддержке CORS в браузере или |
Вызвать этот API | Необязательная ссылка на коллекцию Postman |
Используйте эти поля, чтобы составить список кандидатов. Они не являются актуальной проверкой совместимости или доступности.
Проверьте доступ до написания кода
Для каждого кандидата откройте документацию поставщика и ответьте на следующие вопросы:
Требует ли поставщик учётную запись, ключ API, процедуру OAuth или специальный заголовок?
Какие конечные точки и форматы ответов документируются сегодня?
Какие квоты, ограничения на всплески запросов, правила пагинации и ответы с ошибками применяются?
Разрешает ли данная услуга предполагаемое коммерческое, личное, исследовательское или географическое использование?
Чётко ли определены требования к хранению данных, указанию авторства, конфиденциальности и последующему распространению данных?
Значение Auth в репозитории является подсказкой, а не заменой актуальных инструкций по аутентификации. Метка No не гарантирует неограниченное количество запросов. Метка apiKey или OAuth не сообщает о цене, области действия или процессе утверждения.
HTTPS и CORS — это разные проверки
HTTPS описывает поддержку транспорта согласно данным каталога. CORS касается того, может ли браузер обращаться к сервису из другого источника. Строка с пометкой Yes всё ещё может требовать определённой структуры запроса или иметь ограничения, указанные в собственной документации. Строка с пометкой Unknown требует непосредственной проверки. Если CORS недоступен, запрос с серверной стороны может соответствовать архитектуре с учётом условий поставщика.
Бесплатный доступ и законность зависят от поставщика
Руководство для участников просит отправлять API с полностью бесплатным доступом или как минимум с бесплатным тарифом. Это условие не является гарантией для каждой строки. Поставщики могут изменять квоты, требовать регистрации, вводить платные тарифы или прекращать предоставление сервиса. Правовой статус API и его данных зависит от лицензии поставщика, его условий, источника данных и вашего сценария использования.
Перед использованием в производственной среде сохраните действующие условия поставщика и запишите дату их ознакомления. Запись в репозитории, лицензия MIT репозитория или коллекция Postman не предоставляют прав на базовые данные API.
Как ведется этот список
Руководство для участников требует надлежащей документации, алфавитного порядка внутри категории, кратких описаний и одной ссылки на запрос изменения. Оно также просит участников проверять существующие вопросы и запросы на включение изменений. Запрос на слияние запускает сборку, которая проверяет ссылки. Эти правила объясняют, как предложить исправление. Они не означают, что каждая ссылка останется рабочей.
Если вы обнаружили устаревшую строку, сначала сопоставьте её с официальной документацией поставщика. Затем воспользуйтесь процедурой создания вопроса или запроса на включение изменений в репозитории и опишите точное изменение. Условия поставщика и результаты любых проверок следует отделять от обозначения в каталоге.
Контрольный список перед интеграцией
Документация поставщика открывается и соответствует предполагаемому API.
Принципы аутентификации и работы с секретами понятны.
Квоты и ограничения частоты запросов зафиксированы для учётной записи или тарифа, который вы будете использовать.
HTTPS, CORS, а также доступ с серверной и браузерной стороны соответствуют вашей архитектуре.
Условия использования, лицензия, атрибуция, конфиденциальность и географические ограничения проверены.
Обработка ошибок охватывает тайм-ауты, ответы с кодами, отличными от 2xx, пустые данные и изменения со стороны поставщика.
Ограничения GitHub REST API напоминает о том, что для API-запросов могут существовать задокументированные ограничения. Его правила применяются к API GitHub, а не ко всем сторонним сервисам в этом репозитории.