API documentation

What is an API URL

On this page you will find all the API URLs that you can use with my magic apps. You can use these URLs to send data to my apps or receive data from my apps. Regular URLs start with https:// and you can open them either from an app or from a browser.

Custom URL schemes

Custom URL schemes always start with the app name (like timesmith://), and they can be opened only from an app (not from a browser). If you open a custom URL scheme, the corresponding app will always jump to the front (or will be launched if it's not already running). Some of my apps support returning to another app by using it's custom URL scheme, by adding the "open=xxxxxx" parameter (where xxxxxx is the custom URL scheme of the target app).

Username, PIN and token

You will need to replace UUUUU and PPPP with your username and PIN from the corresponding app, which can be found under USER SETTINGS (tap your username).

For some URLs you can also use your Token, which is displayed under your username an PIN. The token is useful when you want to give someone temporary access, as the token can be re-generated (just tap the refresh icon under the token). In URLs that use the token, you should replace XXXXXXX with your own secret token from the corresponding app.

While your username and PIN stays the same across apps, your token will be unique for each app.

Encoding more complex text

If you would like to push more complex text (that includes spaces and special characters), make sure you use a URL-encoded version.

Example: "Hello Björg!" should be tranformed like "Hello%20Bj%C3%B6rg%21"

MysterSmith app

API URLs

To be able to use the API URLs, you'll need to have the API + A.I. Access add-on.

Get the last text recognition result (in text format):
https://bsmagic.app/api/get_rectext.php?token=XXXXXXX

Get the last text recognition result (in JSON format):
https://bsmagic.app/api/get_rectext_json.php?token=XXXXXXX

Save a new text (in URL encoded form) to the text buffer:
https://bsmagic.app/api/textbuffer.php?action=save&token=XXXXXXX&text=your%20text

Read the last data from the text buffer (in text format):
https://bsmagic.app/api/textbuffer.php?action=get&token=XXXXXXX

Read the last data from the text buffer (in JSON format)
https://bsmagic.app/api/textbuffer_json.php?action=get&token=XXXXXXX

Get the last drawing from the Doodle screen (if saved):
https://bsmagic.app/api/get_last_image.php?token=XXXXXXX

Get the last number / word to use in DFB-X:
https://bsmagic.app/api/get_dfbx.php?token=XXXXXXX

Send a new text to the MysterSmith app via WEB-input:
https://bsmagic.app/api/ps-thump.php?push=1&token=XXXXXXX&thump=yourtext

Custom URL scheme: mystersmith://

You can use the following parameters, even combining them in one URL like this:

mystersmith://?param1=value&param2=value&param3=value

parameter: text
effect: sending a text to the app
format: mystersmith://?text=AAAAAAAA

Example #1 (it will send the text "Hello" to the app):
mystersmith://?text=Hello

Example #2 (it will send the text "Hello World" to the app):
mystersmith://?text=Hello%20World

parameter: return or open
effect: return to (or open) any app, using it's custom URL scheme
format: mystersmith://?open=custom_url_scheme

Example #1 (it will will open the CubeSmith app):
mystersmith://?open=cubesmith

Example #2 (it will send the text "Hello World", then return to the TimeSmith app):
mystersmith://?text=Hello%20World&return=timesmith

PeekSmith app