@@ -20,6 +20,14 @@ Powerful URL shortening tool using different drivers for your Laravel projects
2020 - [ Instantiate Shortener] ( #instantiate-shortener )
2121 - [ Changing driver] ( #changing-driver )
2222- [ Available Drivers] ( #available-drivers )
23+ - [ Bit.ly] ( #bitly )
24+ - [ TinyURL] ( #tinyurl )
25+ - [ Shorte.st] ( #shortest )
26+ - [ Is.gd] ( #isgd )
27+ - [ Cutt.ly] ( #cuttly )
28+ - [ Hide.uri] ( #hideuri )
29+ - [ Firebase] ( #firebase )
30+ - [ Ouo.io] ( #ouoio )
2331- [ Changelog] ( #changelog )
2432- [ Security] ( #security )
2533- [ Credits] ( #credits )
@@ -124,7 +132,8 @@ You can change the default driver by setting `URL_SHORTENER_DRIVER={driver}` in
124132or publish the config file and make your changes there directly.
125133
126134## Available Drivers
127- There are total of 8 drivers available in this package. Below is a list of drivers with their respective specs:
135+ There are total of 8 drivers available in this package. By default, this package will use ` Bit.ly ` as the main driver.
136+ Below is a list of drivers with their respective specs:
128137
129138Service | API Token | Driver name | Analytics | Monetization
130139-------------------------------|-----------|-------------|-----------|-------------
@@ -137,6 +146,99 @@ Service | API Token | Driver name | Analytics | Monetizat
137146[ Firebase Links] ( #firebase ) | yes | ` firebase ` | yes | no
138147[ Ouo.io] ( #ouoio ) | no | ` ouo_io ` | yes | yes
139148
149+ ### Bit.ly
150+ [ Official Website] ( https://bitly.com )
151+
152+ The main default driver for this package. It runs on Bit.ly API and currently using Version 4. To access the Bit.ly driver
153+ in this package, you need to provide ` generic access token ` for OAuth Authentication which can be retrieved in their Bit.ly
154+ Link Management Dashboard. You can parse in your own custom short URL domain (Paid Version) as well.
155+ Currently, there are 2 variables that needs to be set to use the driver.
156+
157+ Variable | Description
158+ --------------------------|----------------------
159+ ` URL_SHORTENER_API_TOKEN ` | Bit.ly API token
160+ ` URL_SHORTENER_PREFIX ` | Custom short URL domain, by default it's ` bit.ly `
161+
162+ ### TinyURL
163+ [ Official Website] ( https://tinyurl.com )
164+
165+ Driver that runs on TinyURL API and currently using Version 2. To access the TinyURL driver in this package,
166+ you need to provide the ` API token ` for OAuth Authentication which can be retrieved in the TinyURL's account setting.
167+ You can parse in your own custom short URL domain (Paid Version) as well. TinyURL provides 3 free custom URL domain prefix
168+ which you can check out at their website. Currently, there are 2 variables that needs to be set to use the driver.
169+
170+ Variable | Description
171+ --------------------------|----------------------
172+ ` URL_SHORTENER_API_TOKEN ` | TinyURL API token
173+ ` URL_SHORTENER_PREFIX ` | Custom short URL domain, by default it's ` tinyurl.com `
174+
175+ ### Shorte.st
176+ [ Official Website] ( https://shorte.st )
177+
178+ Driver that runs on Shorte.st API and currently using Version 1. To access the Shorte.st driver in this package,
179+ you need to provide an ` access token ` which can be retrieved after you have register for a Shorte.st account.
180+ This driver has monetization support where each link that has been clicked will earn a small amount of cash.
181+ Currently, there are only 1 variable that needs to be set to use the driver.
182+
183+ Variable | Description
184+ --------------------------|-------------------------
185+ ` URL_SHORTENER_API_TOKEN ` | Shorte.st API token
186+
187+ ### Is.gd
188+ [ Official Website] ( https://is.gd )
189+
190+ Driver that runs on Is.gd API and currently using Version 1. No API token is needed for this API as there is no
191+ authentication required when sending API request. Currently, there are only 1 variable that needs to be set to use the driver.
192+ This variable determines whether statistic is enabled or disabled when shorten an URL link.
193+
194+ Variable | Description
195+ --------------------------|------------------------------
196+ ` URL_SHORTENER_ANALYTICS ` | Enable or disable statistics
197+
198+ ### Cutt.ly
199+ [ Official Website] ( https://cutt.ly )
200+
201+ Driver that runs on Cutt.ly API and currently using Version 1. To access the Cutt.ly driver in this package,
202+ you need to provide an ` API token ` which can be retrieved in Cutt.ly dashboard. API token will be used within the query
203+ parameters as a method of authentication. This driver comes with analytics and statistics.
204+ Currently, there are only 1 variable that needs to be set to use the driver.
205+
206+ Variable | Description
207+ --------------------------|----------------------
208+ ` URL_SHORTENER_API_TOKEN ` | Cutt.ly API token
209+
210+ ### Hide.uri
211+ [ Official Website] ( https://hideuri.com )
212+
213+ Driver that runs on Hide.uri API and currently using Version 1. No API token is needed for this API as no authentication
214+ is required when sending API request. No variable is needed to setup the driver and you can use straight out of the box.
215+ Check the official website if there is any rate limiting on API calls.
216+
217+ ### Firebase Links
218+ [ Official Website] ( https://firebase.google.com/docs/dynamic-links )
219+
220+ Driver that runs on Google Firebase API and currently using Version 1. To access the Firebase driver in this package,
221+ you need to provide an ` access token ` and a URI prefix which can be retrieved in your Firebase console ` Web API Token ` .
222+ The URI prefix can be set using your own custom domain or any names and it must ends with ` .page.link ` .
223+ The suffix can have the value ` SHORT ` or ` UNGUESSABLE ` .
224+
225+ Variable | Description
226+ -------------------------|------------------------------------
227+ ` URL_SHORTENER_API_TOKEN ` | Firebase API token
228+ ` URL_SHORTENER_PREFIX ` | Custom URL prefix
229+ ` URL_SHORTENER_SUFFIX ` | Creation method during URL shortening
230+
231+ ### Ouo.io
232+ [ Official Website] ( https://ouo.io )
233+
234+ Driver that runs on Ouo.io API and currently using Version 1. To access the Ouo.io driver in this package,
235+ provide the ` API token ` that is available in the Ouo.io account dashboard.
236+ This driver has monetization support where each link that has been clicked will earn a small amount of cash.
237+
238+ Variable | Description
239+ --------------------------|----------------------
240+ ` URL_SHORTENER_API_TOKEN ` | Ouo.io API token
241+
140242## Changelog
141243Please see [ CHANGELOG] ( CHANGELOG.md ) for more information what has been changed in recent versions.
142244
0 commit comments