Rate this page:
One of the big advantages of integrating with Bitbucket Connect is that users have a simple two-click process for installing your app. The first click is either on the Add button in the Bitbucket app directory, or an Install button embedded on a website, or in an application. The second click approves Bitbucket access permissions for your app and completes the installation.
Until your application is listed in the marketplace, users will have to enable development mode before they are able to install your app.
When users click your install button, the next page that appears requests access permissions to their Bitbucket account. It's best practice to place the install button in a location users will be able to trust such as a marketing site, product information site, or company sponsored blog post.
For registered apps, the
href of the button or link must be in the following format:
For unregistered apps, the link must be in the following format:
The following rules apply to the URI construction:
addon_keywhich specifies the key of your app. (For registered apps)
descriptor_urithat points to your app's descriptor. (For unregistered apps)
redirect_urispecifies a URL to redirect the user to after they install the app.
redirect_urimust start with the
baseUrlof your app. Both are plain URLs (not URI Templates) and do not support context parameters.
redirect_urimay be omitted, in which case the user is redirected back to Bitbucket by default.
Read this notice
if you need more help determining if you should use the
Atlaskit makes delivering a beautiful button simple.
The button above is just a simple link styled with the Atlaskit reduced UI pack:
For production environments, we recommend bundling these CSS files with your site, rather than relying on a third-party CDN.
<html> <head> <link rel="stylesheet" href="https://unpkg.com/@firstname.lastname@example.org/dist/bundle.css" media="all"> <link rel="stylesheet" href="https://unpkg.com/@email@example.com/dist/bundle.css" media="all"> </head> <body> <a href="https://bitbucket.org/site/addons/authorize?descriptor_uri=https://example.com&redirect_uri=https://example.com/welcome"> <button type="button" class="ak-button ak-button__appearance-primary">Connect to Bitbucket</button> </a> </body> </html>
If the user accepts the installation, and the app installs successfully, they
will be redirected to the
redirect_uri with the query parameter
clientKey appended. The
clientKey is an opaque key that references the
app's installation for the user or team that installed the app.
If the user does not accept the installation, or the app installation
fails, they will be redirected to the
redirect_uri with the query parameters
error_description appended. At time of writing the known list of
error codes are:
|The user has opted not to grant the app access to their account.|
|The descriptor found at |
|The install URL or parameters were malformed in some way. Common causes are:
|Something unexpected went wrong.|
error_description parameter passed alongside the
for more information about the specific cause. Your page should be resilient to
additional error codes being added in future.
Rate this page: