Skip to content
  • Documentation >
  • Apps >
  • Marketing >
  • Bitly

Bitly

The Bitly modules enable you to shorten links, expand links and list links in your Bitly account.

Getting Started with Bitly

Prerequisites

  • A Bitly account

In order to use Bitly with Ibexa Connect, it is necessary to have a Bitly account. If you do not have one, you can create a Bitly account at bitly.com.

Caution

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Bitly to Ibexa Connect

To connect your Bitly account to Ibexa Connect follow the general instructions for Connecting to services.

After you click the Continue button, Ibexa Connect will redirect you to the Bitly website where you will be prompted to grant Ibexa Connect access to your account.

61d5a950b1fc1.png

Confirm the dialog by clicking the Allow button.

Actions

Shorten URL

Shortens entered URL to the Bitlink.
Long URL Enter the URL you want to convert to the short link.
Organization Select the organization that contains a group you want to use.
Group Select or map the group you want to shorten the link on behalf of.

Retrieves the long URL from the short link.
Bitlink ID Enter (map) the short link you want to be expanded.

Make an API Call

Allows you to perform a custom API call.

URL

Enter a path relative to https://api-ssl.bitly.com. E.g. /v4/groups

For the list of available endpoints, refer to the Bitly API v4 Documentation.

Method

Select the HTTP method you want to use:

  • GET - to retrieve information for an entry.

  • POST - to create a new entry.

  • PUT - to update/replace an existing entry.

  • PATCH - to make a partial entry update.

  • DELETE - to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

The following API call returns all links for the specified group in your Bitly account:

URL:

/v4/groups/Bk2l8aVZxXv/bitlinks

Replace "Bk2l8aVZxXv" by the ID of the group you want to retrieve links for.

Method:

GET

61d5a951d7a70.png

Matches of the search can be found in the module's Output under Bundle \> Body \> links.

In our example, 3 links were returned:

61d5a952ebd20.png

Searches

Retrieves Bitlinks for the specified group.
Organization Select the organization that contains a group you want to use.
Group Select or map the group you want to retrieve links for.
Limit Set the maximum number of results Ibexa Connect will return during one execution cycle.