Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Linkly x-callback-url integration

Integrate Linkly Clipping into your App

You can integrate your App or Website with Linkly starting from Version 1.2.

x-callback-url

Linkly supports x-callback-url, which provides a standardized means for iOS developers to expose and document features of their App to other developers.

Linkly's exposed URL schema

linkly://x-callback-url/clipURL?url=http://apple.com

This is the base URL that you use to clip with Linkly. All other parameters defined by x-callback-url can be passed along, but only the following are respected:

  • x-success
    linkly://x-callback-url/clipURL?url=http://apple.com&x-success=http://furryfishapps.com/linkly
  • x-error (including errorCode=code&errorMessage=message)
    linkly://x-callback-url/clipURL?url=http://apple.com&x-error=http://failwahle.com

Both URLs are called on successful clipping or an error during clipping, respectivley.

Linkly supports clipping the URL in UIPasteboard right after application:didFinishLaunchingWithOptions: has been called. Since this could interfere with calling Linkly's URL schema, you can pass a custom parameter to prevent clipping:

linkly://x-callback-url/clipURL?url=http://apple.com&noCopy=true

Support

If you have any questions, need some help or would like to integrate Linkly deeper into your App, let us know: ask@furryfishapps.com

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment