Terminology URL schemes

If you implement, or plan on implementing, Terminology integration in your app, please drop us a line and let us know, we’d be happy to help.

Terminology on both iPhone and iPad provides support for integration with other apps via the x-callback-url protocol. Methods are provided for search, simple word lookup and allowing the user to select an a replacement word and pass it back to your app. Terminology registers the “terminology://” URL schema. For more information on implementation, visit the x-callback-url website.

x-callback-url Actions

/lookup

• Action: lookup
• Parameters:
  • text [string, required] : The text to lookup. Can be a single word, or a text selection.
  • action [string, optional] : The name of a valid action in either the top or bottom actions list in Terminology. If present, the lookup will open directly to the action as if the action were triggered on the lookup term.
  • x-source [string, optional] : A friendly name for the app making the call. It will be displayed to the user to identify the request.
  • x-success [string, optional] : The URL to use to return the user to the calling application. If provided, the user will get a dialog to allow them to easily return to the calling app after viewing the definition.
• Description: Calling this action with the required “text” parameter will launch Terminology and lookup the text, just as if the user had searched for and selected the text from inside Terminology.
• Example URL, lookup the word “white”:
  • terminology://x-callback-url/lookup?text=white
• Example URL, lookup the phrase “a good deal”:
  • terminology://x-callback-url/lookup?text=a%20good%20deal 

/search

• Action: search
• Parameters:
  • text [string, required] : The text to lookup. Can be a single word, or a text selection.
• Description: Launches Terminology directly to search for the value of the text parameter.
  • terminology://x-callback-url/search?text=white