bitly-shorten/README.md
2020-03-02 12:39:08 -08:00

2.9 KiB

License (3-Clause BSD)
Known Vulnerabilities Quality Gate Status Build Status CircleCI

Bitly Shortener for Kotlin/Java.

A pretty simple and straightforward implementation of the link shortening (bitlinks) abilities of the Bitly v4 API.

Examples (TL;DR)

val bitly = Bitly(/* "YOUR_API_ACCESS_TOKEN from https://bitly.is/accesstoken" */)

// Shorten
bitly.bitlinks().shorten("https://erik.thauvin.net/blog")

// Expand
bitly.bitlinks().expand("http://bit.ly/380ojFd")

// Clicks Summary
bitly.bitlinks().clicks("http://bit.ly/380ojFd")

API Access Token

The Bitly API Access Token can be specified directly as well as via the BITLY_ACCESS_TOKEN environment variable or properties key.

// Env Variable or System Property
val bitly = Bitly()

// Properties file path
val bitly = Bitly(File("my.properties"))

# my.properties
BITLY_ACCESS_TOKEN=abc123def456ghi789jkl0

JSON

All implemented methods can return the full API JSON responses:

bitly.bitlinks().shorten("https://www.erik.thauvin.net/blog", toJson = true)
{
    "created_at": "2020-02-26T06:50:08+0000",
    "link": "http://bit.ly/380ojFd",
    "id": "bit.ly/380ojFd",
    "long_url": "https://erik.thauvin.net/blog"
}

Non-implemented methods can also be called directly:

bitly.call("/user".toEndPoint(), method = Methods.GET)
{
    "created": "2009-06-12T19:00:45+0000",
    "modified": "2016-11-11T19:50:33+0000",
    "login": "johndoe",
    "is_active": true,
    "is_2fa_enabled": true,
    "name": "John Doe",
    "emails": [
        {
            "email": "john@doe.com",
            "is_primary": true,
            "is_verified": true
        }
    ],
    "is_sso_user": false,
    "default_group_guid": "ABCde1f23gh"
}