56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
[](http://opensource.org/licenses/BSD-3-Clause)
|
|
[](https://snyk.io/test/github/ethauvin/isgd-shorten?targetFile=pom.xml) [](https://sonarcloud.io/dashboard?id=ethauvin_isgd-shorten) [](https://travis-ci.com/ethauvin/isgd-shorten) [](https://circleci.com/gh/ethauvin/isgd-shorten/tree/master)
|
|
|
|
# [is.gd](https://is.gd/developers.php) Shortener for Kotlin/Java
|
|
|
|
A simple implementation of the [is.gd API](https://is.gd/developers.php).
|
|
|
|
## Examples (TL;DR)
|
|
|
|
```kotlin
|
|
import net.thauvin.erik.isgd.Isgd
|
|
|
|
...
|
|
|
|
Isgd.shorten("https://www.example.com/") // returns https://is.gd/Pt2sET
|
|
Isgd.lookup("https://is.gd/Pt2sET") // returns https://www.example.com
|
|
|
|
```
|
|
|
|
- View [Kotlin](https://github.com/ethauvin/isgd-shorten/blob/master/examples/src/main/kotlin/com/example/IsgdExample.kt) or [Java](https://github.com/ethauvin/isgd-shorten/blob/master/examples/src/main/java/com/example/IsgdSample.java) Examples.
|
|
|
|
|
|
### JSON or XML
|
|
|
|
The [is.gd API](https://is.gd/developers.php) can return data in plain text (default), JSON or XML.
|
|
|
|
```kotlin
|
|
Isgd.shorten("https://www.example.com/", format = Format.JSON)
|
|
```
|
|
|
|
returns:
|
|
|
|
```json
|
|
{ "shorturl": "https://is.gd/Pt2sET" }
|
|
```
|
|
|
|
### Parameters
|
|
|
|
All of the [is.gd API](https://is.gd/developers.php) parameters are supported:
|
|
|
|
```kotlin
|
|
Isgd.shorten(url = url, shorturl="foobar", callback = "test", logstats = true, format = Format.JSON)
|
|
```
|
|
returns:
|
|
|
|
```json
|
|
test({ "shorturl": "https://is.gd/foobar" });
|
|
```
|
|
|
|
### v.gd
|
|
|
|
Additionally, link can be shorten using v.gd by setting the `isVgd` flag:
|
|
|
|
```kotlin
|
|
Isgd.shorten("https://www.example.com/", isVgd = true) // returns https://v.gd/2z2ncj
|
|
```
|