121 lines
4.4 KiB
Markdown
121 lines
4.4 KiB
Markdown
[](http://opensource.org/licenses/BSD-3-Clause) [](https://github.com/ethauvin/bitly-shorten/releases/latest) [](https://search.maven.org/search?q=g:%22net.thauvin.erik%22%20AND%20a:%22bitly-shorten%22)
|
|
|
|
[](https://snyk.io/test/github/ethauvin/bitly-shorten?targetFile=pom.xml) [](https://sonarcloud.io/dashboard?id=ethauvin_bitly-shorten) [](https://github.com/ethauvin/bitly-shorten/actions/workflows/gradle.yml) [](https://circleci.com/gh/ethauvin/bitly-shorten/tree/master)
|
|
|
|
# [Bitly](https://dev.bitly.com/v4/) Shortener for Kotlin/Java/Android
|
|
|
|
A simple implementation of the link shortening (Bitlinks) abilities of the [Bitly v4 API](https://dev.bitly.com/api-reference).
|
|
|
|
## Examples (TL;DR)
|
|
|
|
```kotlin
|
|
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("https://bit.ly/380ojFd")
|
|
|
|
// Clicks Summary
|
|
bitly.bitlinks().clicks("https://bit.ly/380ojFd")
|
|
|
|
// Create a bitlink
|
|
bitly.bitlinks().create(title = "Erik's Weblog", long_url = "https://erik.thauvin.net/blog/")
|
|
|
|
// Update a bitlink
|
|
bitly.bitlinks().update("https://bit.ly/380ojFd", title="Erik's Weblog", tags = arrayOf("blog", "weblog"))
|
|
```
|
|
|
|
- View [Kotlin](https://github.com/ethauvin/bitly-shorten/blob/master/examples/src/main/kotlin/com/example/BitlyExample.kt) or [Java](https://github.com/ethauvin/bitly-shorten/blob/master/examples/src/main/java/com/example/BitlySample.java) Examples.
|
|
|
|
### API Access Token
|
|
|
|
The Bitly API [Access Token](https://bitly.is/accesstoken) can be specified directly as well as via the `BITLY_ACCESS_TOKEN` environment variable or properties key.
|
|
|
|
```kotlin
|
|
// Env Variable or System Property
|
|
val bitly = Bitly()
|
|
|
|
// Properties file path
|
|
val bitly = Bitly(File("my.properties"))
|
|
|
|
```
|
|
```ini
|
|
# my.properties
|
|
BITLY_ACCESS_TOKEN=abc123def456ghi789jkl0
|
|
```
|
|
|
|
### Gradle, Maven, etc.
|
|
|
|
To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/bitly-shorten/blob/master/examples/build.gradle.kts) file:
|
|
|
|
```gradle
|
|
dependencies {
|
|
implementation("net.thauvin.erik:bitly-shorten:0.9.3")
|
|
}
|
|
```
|
|
|
|
Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://search.maven.org/artifact/net.thauvin.erik/bitly-shorten/0.9.3/jar).
|
|
|
|
### JSON
|
|
|
|
All implemented API calls can return the full JSON responses:
|
|
|
|
```kotlin
|
|
bitly.bitlinks().shorten("https://www.erik.thauvin.net/blog", toJson = true)
|
|
```
|
|
```json
|
|
{
|
|
"created_at": "2020-02-26T06:50:08+0000",
|
|
"link": "https://bit.ly/380ojFd",
|
|
"id": "bit.ly/380ojFd",
|
|
"long_url": "https://erik.thauvin.net/blog"
|
|
}
|
|
```
|
|
|
|
You can also access the last response from implemented API calls using:
|
|
|
|
```kotlin
|
|
val bitlinks = Bitlinks(apikey)
|
|
|
|
val shortUrl = bitlinks.shorten(longUrl)
|
|
|
|
val response = bitlinks.lastCallResponse
|
|
|
|
if (response.isSuccessful) {
|
|
println(response.body)
|
|
}
|
|
```
|
|
|
|
Non-implemented API calls can also be called directly:
|
|
|
|
```kotlin
|
|
val response = bitly.call("/user".toEndPoint(), method = Methods.GET)
|
|
if (response.isSuccessful) {
|
|
println(response.body)
|
|
}
|
|
```
|
|
```json
|
|
{
|
|
"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"
|
|
}
|
|
```
|
|
- View [Example](https://github.com/ethauvin/bitly-shorten/blob/master/examples/src/main/kotlin/com/example/BitlyRetrieve.kt)
|
|
|
|
### More...
|
|
If all else fails, there's always more [Documentation](https://ethauvin.github.io/bitly-shorten/).
|