Phraseology URL schemes

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

NOTE: THESE URL SCHEMES REQUIRE PHRASEOLOGY 2.0 OR GREATER, TO BE RELEASED Feb. 2014.

Phraseology provides support for integration with other apps via the x-callback-url protocol. Methods are provided for document creation and manipulation, as well as for using arrange and inspect features from other apps. Phraseology registers the “phraseology://” and “x-phraseology://” URL schemas. For more information on implementation, visit the x-callback-url website.

For the most part, these URL actions all support x-success, and sometimes x-cancel parameters specified by x-callback-url to fire a callback after the action is complete

Note: {{}} brackets in examples indicate the value should be URL encoded in use.

Document Related Actions

/create

  • Action: create
  • Parameters:
    • title [string, required] : Title of the new document.
    • text [string, required] : Content for the new document.
  • Description: Creates a new document in Phraseology with the included title and text.
  • Example URL:
    • phraseology://x-callback-url/create?title=Hello%20World&text=Hello%20Document

/open

  • Action: open
  • Parameters:
    • title [string, optional] : Title of the document.
    • uuid [string, option] : Unique identifier for document.
  • Description: Opens an existing document. Either uuid or title parameter are required. The link to directly open a document can be copied to the clipboard using the "Copy Link" button in Phraseology's share menu. If title is used, and more than one document with the same title exist, the most recently accessed will be opened.
  • Example URL:
    • phraseology://x-callback-url/open?title=Hello%20World

/append

  • Action: append
  • Parameters:
    • title [string, optional] : Title of the document.
    • uuid [string, optional] : Unique identifier for document.
    • text [string, required] : Text to append to the end of the document.
  • Description: Opens an existing document and appends the text to the end of the document. Either uuid or title parameter are required. The link to directly open a document can be copied to the clipboard using the "Copy Link" button in Phraseology's share menu. If title is used, and more than one document with the same title exist, the most recently accessed will be opened.
  • Example URL:
    • phraseology://x-callback-url/append?title=Hello%20World&text=AppendThis

/prepend

  • Action: prepend
  • Parameters:
    • title [string, optional] : Title of the document.
    • uuid [string, optional] : Unique identifier for document.
    • text [string, required] : Text to prepend at the beginning of the document.
  • Description: Opens an existing document and prepends the text to the beginning of the document. Either uuid or title parameter are required. The link to directly open a document can be copied to the clipboard using the "Copy Link" button in Phraseology's share menu. If title is used, and more than one document with the same title exist, the most recently accessed will be opened.
  • Example URL:
    • phraseology://x-callback-url/prepend?title=Hello%20World&text=AppendThis

/get

  • Action: get
  • Parameters:
    • title [string, optional] : Title of the document.
    • uuid [string, optional] : Unique identifier for document.
    • x-success [string, required] : Callback URL to send document contents.
  • Description: Locates a document via uuid or title provided, and calls the x-success callback URL with "title" and "text" parameters appended. Can be used to fetch the current contents of a document in a workflow/automation environment.
  • Example URL:
    • phraseology://x-callback-url/get?title=Hello%20World

Services

/arrange

  • Action: arrange
  • Parameters:
    • text [string, optional] : Text to arrange.
    • retParam [string, optional] : Optional name to be used for the parameter appended to the x-success callback with the arranged text.
    • x-success [string, optional] : Callback URL to use if the user finishes arranging with the "Done" button.
    • x-cancel [string, optional] : Callback URL to use if the user finishes arranging with the "Cancel" button.
  • Description: Opens the text provided in Phraseology's "Arrange" view, allowing the user to reorder paragraphes and sentences via drag and drop. When the user completes arranging by tapping the "Cancel" button, the x-cancel parameter can be used to return the user to another app without any changes. If the user taps "Done", the x-success callback will be fired with the post-arranging text added as the "text" parameter. If "retParam" is provided, the return parameter for the arranged text will be named according to it's value. No document is created or text saved in Phraseology.
  • Example URL:
    • phraseology://x-callback-url/arrange?text=TextToArrange&x-success={{myapp://myaction/}}&x-cancel={{myapp://}}

/inspect

  • Action: inspect
  • Parameters:
    • text [string, optional] : Text to inspect.
    • x-success [string, optional] : Callback URL to use if the user finishes arranging with the "Done" button.
  • Description: Opens the text provided in Phraseology's "Inspect" view, to display readability scores, statistics and linguistic breakdowns for text. No document is created or text saved in Phraseology.
  • Example URL:
    • phraseology://x-callback-url/inspect?text=TextToArrange&x-success={{myapp://myaction/}}
Have more questions? Submit a request

Comments

Please sign in to leave a comment.