Bitly

How to enable Bitly Link Mask on a merchant.

Bitly is a popular URL shortening service that allows users to create shorter versions of long URLs, making them easier to share across platforms, especially on social media.

Features

Resources

Configuration

To configure Bitly, start by logging into the Bitly developer dashboard. From there, you can manage bitly settings and review client id and secret or access token features. For detailed setup instructions and access to access token, refer to the developer documentation available on Bitly's website. If you need additional help, you can contact their support team via email.

This table describes the required or possible attributes needed to configure a merchant product for this type.

NameTypeDescriptionRules
hoststringBase URL used for API requests to the Bitly. Examples: api-ssl.bitly.com.
accessTokenstringThis is the access token used for API authentication with Bitly services. You can obtain it by registering and generating an access token within the Bitly developer portal. Examples: your_access_token_here.
shortenerDomainstringCustom domain configured in bitly developer portal. Examples: bit.ly.
groupGuidstringGroup unique id available in bitly developer portal. Examples: Bitly group unique id.

Features

All messaging products support the following features attributes.

NameValuesDescription
noAuthcodetrue or false (default)All messages sent to customers using this product will never include an authorization response code.

Enabling this Product

Using create-merchant-product API you can add a new product to your merchant record. Below is an example configuration for the payload of that request.

{
  "line": "messaging",
  "product": "link-mask",
  "provider": "bitly",
  "config": {
    "host": "api-ssl.bitly.com",
    "accessToken": "your_access_token_here",
    "shortenerDomain": "bit.ly",
    "groupGuid": "Bitly group unique id"
  }
}