Welcome to url-shortener-api 👋

an api to shorten some url

🏠 Homepage

The api endpoint is at https://url-shortener.api.ripoul.fr/api/.

Documentation can be found here.

Here some usefull request :

• http://url-shortener.api.ripoul.fr/api/providers to list the available providers
• http://url-shortener.api.ripoul.fr/api/tinyurl?url=[LONG_URL] to shorten the url with tinyurl

I've made a web interface. You can find the code here and the live demo here.

🔨 Install

pip install -r requirements.txt

🔧 Usage

python manage.py runserver

If you want all the features, you will need a .env file with 7 items in it :

• cuttlyAPI -> contains the api key for cuttly
• rebrandlyAPI -> contains the api key for rebrandly
• bittlyAPIgroup -> contains the api group id from bittly
• bitlyAPI -> contains the api key from bittly
• tinyccAPI -> contains the api key from tinycc
• tinyccLogin -> contains the login of tinycc
• kuttitAPI -> contains the login of kuttit

✅ Run tests

python manage.py test

Author

👤 Jules

• Github: @ripoul

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Jules.
This project is MIT licensed.