surehub-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #llm #rust #deep-learning #linux #nodejs #kubernetes #vue #security #pytorch #ios

(★ 31)

The unofficial SureHub API is a simple, yet powerful RESTful API for products from Sure Petcare

surehub-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SureHub API

SureHub API is a simple, yet powerful RESTful API for products from [Sure Petcare](https://www.surepetcare.com).

<div align="center">
  <a href="https://fabieu.github.io/surehub-api/" target="_blank" style="font-weight: bold;">
    OpenAPI documentation
  </a>
</div>

---

[![GitHub Release](https://img.shields.io/github/v/release/fabieu/surehub-api)](https://github.com/fabieu/surehub-api/releases/latest)
[![GitHub Issues](https://img.shields.io/github/issues/fabieu/surehub-api)](https://github.com/fabieu/surehub-api/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/fabieu/surehub-api)](https://github.com/fabieu/surehub-api/pulls)
[![License](https://img.shields.io/github/license/fabieu/surehub-api)](https://github.com/fabieu/surehub-api/blob/main/LICENSE)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fabieu_surehub-api&metric=alert_status)](https://sonarcloud.io/summary/overall?id=fabieu_surehub-api)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=fabieu_surehub-api&metric=security_rating)](https://sonarcloud.io/summary/overall?id=fabieu_surehub-api)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=fabieu_surehub-api&metric=reliability_rating)](https://sonarcloud.io/summary/overall?id=fabieu_surehub-api)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=fabieu_surehub-api&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=fabieu_surehub-api)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=fabieu_surehub-api&metric=vulnerabilities)](https://sonarcloud.io/summary/overall?id=fabieu_surehub-api)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=fabieu_surehub-api&metric=sqale_index)](https://sonarcloud.io/summary/overall?id=fabieu_surehub-api)

---

# Install

## Docker (recommended)

> [!NOTE]
> Starting with version 7.0.0, images are exclusively published to the [GitHub Container Registry](https://github.com/fabieu/surehub-api/pkgs/container/surehub-api) (`ghcr.io`). Docker Hub is no longer updated.
> 
> **Migration:** Update the `image` field in your `docker-compose.yaml`:
> ```diff
> - image: fabieu/surehub-api:latest
> + image: ghcr.io/fabieu/surehub-api:latest
> ```

```bash
docker run -d -p 8080:3001 -e SUREHUB_EMAIL='{YOUR_SUREHUB_EMAIL}' -e SUREHUB_PASSWORD='{YOUR_SUREHUB_PASSWORD}' ghcr.io/fabieu/surehub-api:latest
```

> For all available options take a look at the [Configuration](#configuration) section.

## Manual install

Clone this repository to your system and move into the project subfolder:

```bash
git clone https://github.com/fabieu/surehub-api.git
```

This project utilizes **Poetry**, a tool for dependency management and packaging in Python. It allows you to declare the
libraries your project depends on and it will manage (install/update) them for you (https://python-poetry.org/).

Install poetry via pip:

```bash
pip install --user poetry
```

Installing required dependencies and move into the virtual environment created by Pipenv:

```bash
poetry install
```

Set at least the required environment variables:

```bash
export SUREHUB_EMAIL={YOUR_SUREHUB_EMAIL}
export SUREHUB_PASSWORD={YOUR_SUREHUB_PASSWORD}
```

Start the integrated webserver with the following command:

```bash
poetry run python .\surehub_api\main.py
```

> For all available options take a look at the [Configuration](#configuration) section.

# Configuration

The configuration is done via environment variables. The following options are available:

### `SUREHUB_EMAIL` (required)

Email of your _Sure Petcare_ account. Make sure to use an account with control privileges if you want to use the full
capabilities of this API. You can change the privileges on the official Sure Petcare website.

### `SUREHUB_PASSWORD` (required)

Password of the in `SUREHUB_EMAIL` specified _Sure Petcare_ account.

### `SUREHUB_LOGLEVEL` (optional)

> Default: info

The `SUREHUB_LOGLEVEL` option controls the level of log output and can be changed to be more or less verbose, which
might be useful when you are dealing with an unknown issue.

- `trace`: Show every detail, like all called internal functions.
- `debug`: Shows detailed debug information.
- `info`: Normal (usually) interesting events.
- `warning`: Exceptional occurrences that are not errors.
- `error`: Runtime errors that do not require immediate action.
- `fatal`: Something went terribly wrong. Add-on becomes unusable.

### `SUREHUB_PORT` (optional)

> Default: 3001

The port for the ASGI server. This is the same as the port used for API requests. Please make sure that the specified
port isn't used by another application.

### `SUREHUB_CORS` (optional)

> Default: None

Enables CORS (Cross-Origin Resource Sharing) for browser-based frontends that call this API from a different origin.
Define a comma-separated list of fully qualified origins (scheme + host + optional port) to allow.

When unset (the default), CORS headers are not added and all cross-origin browser requests are blocked. This is the
correct default for local or trusted-network use — tools like `curl`, Postman, and server-side clients are unaffected
by CORS regardless of this setting.

**Wildcards (`*`) are not supported.** Allowing all origins means any website can call your API from a browser,
which exposes your Sure Petcare data to arbitrary third-party pages. Explicit origins are always required.

Examples:

```bash
# Single origin
SUREHUB_CORS=https://app.example.com

# Multiple origins (comma-separated, no spaces)
SUREHUB_CORS=https://app1.example.com,https://app2.example.com
```

# Usage

For details about all API endpoints and the corresponding request and response models take a look at the automatically
generated OpenAPI documentation:

- **https://fabieu.github.io/surehub-api/**

Here you will find everything you need to know about the available endpoints and how to call them.

If you have additional questions feel free to open an issue here on GitHub.

# Changelog & Releases

This repository keeps a changelog using GitHub's releases functionality.

Releases are based on Semantic Versioning, and use the format of `MAJOR.MINOR.PATCH`. In short, the version will be
incremented based on the following:

- `MAJOR`: Incompatible or major changes.
- `MINOR`: Backwards-compatible new features and enhancements.
- `PATCH`: Backwards-compatible bugfixes and package updates.

# Special Thanks

Thanks to [alextoft](https://github.com/alextoft) and [hdurdle](https://github.com/hdurdle) for their GitHub projects
and shared resources about the SureHub API.  
You can look at the projects following the links below:

- https://github.com/alextoft/sureflap
- https://github.com/hdurdle/sureflap

# Licence

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the
License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "
AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.

# Disclaimer

### This project isn’t endorsed by SureFlap Ltd. and doesn’t reflect the views or opinions of SureFlap Ltd. or anyone officially involved in producing or managing Sure Petcare.

surehub-api

surehub-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

surehub-api

surehub-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README