Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/extratone/routinehub-api
An unofficial, amateur attempt at documenting the original RoutineHub API in contemporary formats.
https://github.com/extratone/routinehub-api
api postman routinehub siri-shortcuts
Last synced: about 1 month ago
JSON representation
An unofficial, amateur attempt at documenting the original RoutineHub API in contemporary formats.
- Host: GitHub
- URL: https://github.com/extratone/routinehub-api
- Owner: extratone
- License: other
- Created: 2022-09-01T09:10:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-01T10:33:06.000Z (over 2 years ago)
- Last Synced: 2024-05-02T03:48:31.557Z (9 months ago)
- Topics: api, postman, routinehub, siri-shortcuts
- Homepage: https://extratone.github.io/RoutineHub-API
- Size: 1.11 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# RoutineHub API
## An *unofficial*, amateur attempt at documenting the original RoutineHub API in contemporary formats.
### Postman
(Still not sure I've done this bit right.)
- [Collection](https://documenter.getpostman.com/view/15808119/VUxPu7SH)
- [API](https://www.postman.com/extratone/workspace/extranet/api/a249de6e-4c37-47a0-b006-b21adc3fb5da)
[**mvan231's repository**](https://github.com/mvan231/RoutineHubDocs) is my singular source. Here's its README, verbatim:
---
Root URL: `https://routinehub.co/api/v1/`
All API endpoints are based on the root url.
**Note:** This documentation is for v1 of the API. The new v2 has not been released yet.
##### Table of Content
> * [Shortcut ID](#shortcut-id)
> * [API Key](#api-key)
> * [Key Generation](#key-generation)
> * [Revoke Key](#revoke-key)
> * [Storage](#storage)
> * [GET Endpoints](#get-endpoints)
> * [List User Shortcuts](#list-user-shortcuts)
> * [Get Latest Shortcut Version Info](#get-latest-shortcut-version)
> * [POST Endpoints](#post-endpoints)
> * [Create Shortcut version](#create-shortcut-version)
> * [Publish Shortcut](#publish-shortcut)
> * [Unpublish Shortcut](#unpublish-shortcut)
## Shortcut ID
The is a numeric ID assigned to the shortcut on the site when a new shortcut is created.
To find this ID after creating the shortcut on RoutineHub, tap/click on the address bar and view the numeric ID value.
Example: https://routinehub.co/shortcut/7388/version/create
RoutineHub Shortcut ID: 7388
-----
## API Key
### Key Generation
Where is needed, the user has to generate the key. This can be done from the RoutineHub settings page.
### Revoke Key
It is not currently possible to revoke a key, but if you generate a new key, the old key will become invalid
### Storage
It is Preferred that this be stored locally to the user's system and not on your servers anywhere.
----
## GET Endpoints
### List User Shortcuts
`GET 'api/v1//shortcuts'`
Simply retrieves a list of the user's shortcuts with their IDs and whether it's published or not.
### Get Latest Shortcut Version Info
`GET 'api/v1/shortcuts//versions/latest'`
Gets the latest version of a shortcut. No api key needed.
-----
## POST Endpoints
### Create Shortcut version
`POST 'api/v1//shortcuts//versions/create'`
Creates a new version for a shortcut.
Parameters:
'version' : The version number
'link' : Link to the shortcut on iCloud
'changes' : List of changes for this version
### Publish Shortcut
`POST 'api/v1//shortcuts//publish'`
Changes the publish status of a shortcut to True.
### Unpublish Shortcut
`POST 'api/v1//shortcuts//unpublish'`
Changes the publish status of a shortcut to False.