Skip to content

OnlyCatAI/onlycat-developer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

OnlyCat Developer

Welcome

This is the developer hub for the OnlyCat smart cat flap:
https://www.onlycat.com

We’ll be sharing APIs, developer documentation, and featuring community-built projects.


πŸ’¬ Discussion

Join the conversation on GitHub Discussions:
https://github.com/OnlyCatAI/onlycat-developer/discussions


πŸ’¬ Discord

Join the OnlyCat community:
https://discord.gg/Xg3bCgXbZa


πŸ“˜ Door Policy Schema

Learn about the OnlyCat Door Policy schema: https://www.onlycat.com/door-policy-schema/


πŸ”‘ API Keys

Enable Developer Mode in the OnlyCat app under Account, then open API Keys to create a key for your integration.

API keys have full access to your OnlyCat account. Create a separate key for each integration, store it securely, and revoke it from the app when it is no longer needed. A new key is displayed only when it is created.

Use the key as the Socket.IO authentication token:

import asyncio
import socketio

async def main():
    client = socketio.AsyncClient()
    await client.connect(
        "https://gateway.onlycat.com",
        transports=["websocket"],
        auth={"token": "oc_live_..."},
    )
    await client.wait()

asyncio.run(main())

API key authentication grants the same account-level Socket.IO access as the OnlyCat app. REST bearer authentication is not currently supported.


🏠 Home Assistant Integration

Official community integration:
https://github.com/OnlyCatAI/onlycat-home-assistant


πŸš€ Submit Your Project

Built something with OnlyCat?

Open a GitHub Discussion or pull request to share your project and get featured.

About

OnlyCat Developer Community | APIs, Third Party Projects, Integrations

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors