You can purchase the "Dictionary API" add-on directly from Ben Laxton for 130AUD (~80 EUR) on this website:
bsmagic.app/payment/dictionary_purchase.php
The easiest way to use the Dictionary API is the integrated support in the PeekSmith app.
First of all you will need to enter/get the word somehow - this can be achieved by a handful of methods:
Then you will need to trigger the "Dictionary API position" action (see the screenshot), using any of the available action triggers (PeekSmith button press, Atom remote button press, volume buttons, Apple Watch tap/swipe etc).
The app will then query the info from the webserver (internet connection needed), and display the results in a short/long version, depending on the type of the display. Please see the screenshots for a better understanding.
Explanation for the short version (the one you see on the PeekSmith Screen):
You can also use the "Dictionary API" with any 3rd party app or service, by accessing the WEB API directly. You will need two things for this: enable 3rd party access in the PeekSmith app (it will be active for 1 hour), and use your secret token in the API query.
In the PeekSmith app go to SETTINGS - DICTIONARY API ADD-ON - and turn ON "Enable 3rs party apps (1 hour)". This will activate the 3rd party access of the API URLs for 1 hour. If you turn the toggle OFF and then ON again, the 1 hour timeout will be reset.
Then locate and copy your secret token, which can be found in the PeekSmith app: go to SETTINGS - USER SETTINGS - and tap your username. On the next page you will find the secret token under your username and PIN. You can re-generate the token by tapping the recycle button, or copy the token to the clipboard by tapping the copy icon.
Now you are ready to use the following API URLs from any 3rd party app or service.
https://bsmagic.app/api/dictionary/dictionary_get_text.php?token=XXXX&search=word
Replace "XXXX" with your token and "word" with the actual word you are looking for. The result will be a short summary of the location of the word in the dictionary:
https://bsmagic.app/api/dictionary/dictionary_get_json.php?token=XXXX&search=word
Replace "XXXX" with your token and "word" with the actual word you are looking for. The result will be a detailed info in JSON format about the location of the word in the dictionary:
Explanation of the JSON fields:
success: 0=error or 1=OK
word: the word you were looking for
page, column, line: the location of the word
extra: 0=regular word with explanation, 1=word without explanation in the extra columns
wordcount: the number of the word in the column (from top)
wordcount_txt: detailed info about the number of the word
verticalpos: short info about the vertical position of the word
verticalpos_txt: detailed info about the vertical position of the word
If the success field returns a 0 value, there will be also an error message included for a better understanding.