routinehub-api

An unofficial, amateur attempt at documenting the original RoutineHub API in contemporary formats.

https://github.com/extratone/routinehub-api

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary

Keywords

api postman routinehub siri-shortcuts
Last synced: 6 months ago · JSON representation ·

Repository

An unofficial, amateur attempt at documenting the original RoutineHub API in contemporary formats.

Basic Info
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 5
  • Releases: 1
Topics
api postman routinehub siri-shortcuts
Created over 3 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

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.)

mvan231's repository 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

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/<api_key>/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/<shortcut_id>/versions/latest'

Gets the latest version of a shortcut. No api key needed.


POST Endpoints

Create Shortcut version

POST 'api/v1/<api_key>/shortcuts/<shortcut_id>/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/<api_key>/shortcuts/<shortcut_id>/publish'

Changes the publish status of a shortcut to True.

Unpublish Shortcut

POST 'api/v1/<api_key>/shortcuts/<shortcut_id>/unpublish'

Changes the publish status of a shortcut to False.

Owner

  • Name: David Blue
  • Login: extratone
  • Kind: user
  • Location: Columbia, Missouri
  • Company: @softwarehistorysociety

Self-described Software Historian (and lapsed auto journalist,) writing in public via GitHub and here to help. If I've screwed up, tell me! (Please)

Citation (CITATION.cff)

abstract: "The Psalms (alternatively/interchangeably entitled Bilge) is a monobyline World Wide Web Blog written by 𝒟𝒶𝓋𝒾𝒹 ℬ𝓁𝓊ℯ (good morning!) observing and selectively amplifying the characters, organizations, and stories surrounding the most abrupt, profound, and spectacular communicative renaissance in the history of the human species. Less abstractly, its beat is wholly digital, namely in tools (software, services, and methodologies) and culture (music, film, podcasts, and media) from a distinct lens established at good distance from California. It is unlicensed and entirely written in public largely via this GitHub Repository, supplemented by experiments on a variety of other platforms, including (arguably) my Twitter account."
authors: 
  - family-names: Blue
    given-names: David
    orcid: "https://orcid.org/0000-0002-9307-2251"
cff-version: "1.2.0"
version: 3.11
date-released: 2021-10-15
keywords: 
  - media
license: "The Unlicense, Dave Edition"
license-url: https://davidblue.wtf/license
repository-code: "https://github.com/extratone/bilge"
title: "The Psalms"

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 5
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • extratone (5)
Pull Request Authors
Top Labels
Issue Labels
documentation (5)
Pull Request Labels