dub icon indicating copy to clipboard operation
dub copied to clipboard

[Feature] API support

Open khaosdoctor opened this issue 3 years ago • 12 comments
trafficstars

One of the most useful things I'd find to have in Dub would be the possibility to CRUD links using an API, this way we could automate the creation using tools like Notion and others.

From my perspective, and I'm willing to implement it, is to have a settings page to create an API key that can be used to control the link managing.

Any thoughts about it?

khaosdoctor avatar Oct 10 '22 13:10 khaosdoctor

Oh I love that! So to summarize, here's the user experience:

  • User creates an account on Dub via https://app.dub.sh/register
  • User gets their API key from https://app.dub.sh/settings
  • User makes requests to the Dub API to create/edit dub.sh links via a third party app

Do we want this to be for dub.sh short links only or for custom domains as well?

Related issue: #30

steven-tey avatar Oct 10 '22 16:10 steven-tey

I'd really want to be for all domains, since, in my case, I use dub with my custom domain, so having the possibility to streamline, for example, my newsletter link sharing (which is saved in notion) to automatically shorten the links with dub, then update the newsletter with them would be -> AWESOME <-

The feature itself is not that hard to implement, backend-wise, I'll do my best on the frontend, but I think I can show something working next week o/

khaosdoctor avatar Oct 10 '22 19:10 khaosdoctor

@khaosdoctor sounds good! We'd wanna leverage some of next-auth's existing features to handle API authentication as well (preferably using a Authorization: Bearer xxxxx header.

I'm also planning to add a docs page too to document the API!

steven-tey avatar Oct 30 '22 01:10 steven-tey

Any updates?

oleynikd avatar Dec 16 '22 10:12 oleynikd

I'm making some decent progress on this, apologies for the delay, I got a bit distracted by the AI/ChatGPT hype haha

Aiming to launch the official Dub API in the first/second week of Jan 2023!

steven-tey avatar Dec 22 '22 04:12 steven-tey

Thanks a lot, life happened here and I got several unplanned problems that came my way and I ended up not having enough time to implement the solution...

khaosdoctor avatar Dec 29 '22 22:12 khaosdoctor

Sorry for annoying but, any update on this? :) I am planning on creating some bot to shorten links directly from Slack.

amitizle avatar Jan 29 '23 11:01 amitizle

Also looking forward to this!

martinkallstrom avatar Feb 20 '23 15:02 martinkallstrom

I'm waiting!

amblerkr avatar Mar 08 '23 11:03 amblerkr

Sorry for the delay on this but I still very much intend to ship the official Dub API. I'm estimating to ship it by May but there are a few other features that take priority, so it might take another month or so. Will keep y'all posted! 🙏

steven-tey avatar Mar 14 '23 03:03 steven-tey

Really looking forward to this as well!

I recently made a ChatGPT plugin that creates a functioning website and returns a shareable link.

I'm doing this with itty.bitty.sites, which are websites whose data is entirely contained in the URL. You can do quite a lot with compressing HTML/CSS/JS and appending it in the URL. With itty.bitty and the ChatGPT plugin, you can essentially create mini-websites on the fly simply by describing them.

The challenge is that these URLs tend to be quite long, so I want to build in a link shortener so that the link that gets returned is a short link like https://dub.sh/snake-game rather than a super long one like this: https://itty.bitty.site/Snake-Game/d/A%20simple%20snake%20game%20created%20using%20HTML,%20CSS,%20and%20JavaScript./f/%F0%9F%90%8D/#/XQAAAALoBgAAAAAAAAAeCEUG0O+oKBdZ2an16qclQGqN7T6CIDzO1tpHtdvWKM3DIEdkYuxuyN4YKAxiFUKMhl1v7ctVwHkvIo9+bBW4CCic64aJ9o7DyJ2wwW7vfRUxYVk75lWvlvP+N1/A74KxsxRLOaGguoyv/Ww/0i3aIctaPV8pm/ivIFN19WwPcoAnGYjQ76EshtrvD0G1I0tdeSKu+h7GcQrELnUTZoifINRgptBvAKzu37yJBaZAByRZN5lYp172wdgI2GpbGShQ2ZcZ7LrEzDDczp8Y5jnJTK8zlD6tjbQp6SXiKtL6sRFyu+gBTl4GV+1PFN9y1RxNGgqZb3rVYsrxj1ISPH0uVqVp1rE4axkrwFOl2YPCdXKaM8NqP+nJqyFvIKCsQ7lIygye1YTouysIaGwiSe4CFsxZ4CHlWsW1YxtK1TywfhElkqeHf9fQIeNo/zbZxJn/knlvVABBrfD5T0wPVUcs3H/TmSxwiyT3LNrwFG4vrv2wltb03gCr3KwCZ5Xbp3PVwucf/ExAys0SMq0yjWrE3tNlDhxW3tFHVDxR9MIT7sY6HohPQpZ1yQwH1zXCan69zB+yvrwjkVpr1v97cuXqZRFSeh9cIrZ6xWwpECIHFiiTJZNBIRO9jZ5LyEKfbWlfNcpMilR6EvvxGOMC+/377N4U4o1KwhsdQAMYUBW5VsP4zc7+x+I2x+OALphqIulYHVRStrL0K4YKEbI0H3PuAdGv170/mgvJXZv4iglHYzC2u+f3tHWT+6rklSXXxtt6UUt7OdN5pstZ4m9bNj6j7UY18X0xCaiiIPufX/8Caf5pSdIWF7h6MulDMOziGOxhkMGHN4V2GNwVWOmd9zDDPZbIOqgChTSwfGsf0FZ9WKNfRyNHagWSQrgpXfQfXoxiwXw0ug4Pj5ViQ+jmggP2i5nJ8wykCpN1F7GqzkJMgpsqlcy6LgeOYvnd6NopHznm3dkgCskiNIKkfNjoKRUJu+Dn2/pRFOa1uZEWFnM6wJKXw2c/W3tJG8s9VU04AcUhdwiO32Qsw7zCHW3Uv0WWnKRoI8/LKAspBf1MG4XxU8QlKkMej3Yqoe+8jq6/fzuH6/5K3do=

jinalex avatar Apr 09 '23 17:04 jinalex

Up!!

I believe that dub.sh is behind schedule on this feature, as it is an amazing link shortener with plenty of features, and they should want to include all the features in their API. Instead, they are only adding the basic link creation functionality with just three field options: the target link, the slug, and the project's domain or ID. This would already solve numerous integrations, and later on, we can implement other features in the API.

nennogabriel avatar May 19 '23 09:05 nennogabriel

Any update on this? Link shortening through API is one of the most important parts for many businesses.

atumas-bananamilk avatar Jul 17 '23 06:07 atumas-bananamilk

Totally agree with @atumas-bananamilk, a major point of a link shortener service is the integrations between other systems and the service. @steven-tey is it possible to get a time estimation for this? Not complaining, but we do need some realistic estimation (the other estimations in this threads are way off) to understand how we're gonna use the service moving forward.

amitizle avatar Jul 17 '23 07:07 amitizle

I'm leaving my comment here because I won't be able to work on this anymore, I tried a few times back but I couldn't actually set the system locally here, so I stopped trying... But this is still a great feature if someone is able to do it.

khaosdoctor avatar Jul 17 '23 12:07 khaosdoctor

@atumas-bananamilk @amitizle – apologies for the inaccurate estimations before, but this is definitely a top priority feature for Dub. Here's what we have planned:

  • REST API
  • Zapier integration
  • Raycast integration
  • dub JS SDK

The current ETA for this feature is September 2023 – we're currently blocked by one other major update that we're shipping to Dub (rebranding to a different TLD 🫣🤫) but once that's done, we'll be full-steam ahead on the API! 🙏

If you're interested in the Dub API – please sign up on this form here!

steven-tey avatar Jul 17 '23 15:07 steven-tey

@steven-tey We've moved on with short.io which has everything, including analytics through API. Keep me updated though, I really liked the simplicity and usability.

atumas-bananamilk avatar Jul 26 '23 00:07 atumas-bananamilk

Will do! Planning to build out a short.io migrator soon as well to make things easier if you do decide to switch in the future (when Dub's API feature is live)! 😄

Edit: Short.io migrator is now live: https://dub.sh/help/article/migrating-from-short

steven-tey avatar Jul 26 '23 03:07 steven-tey

Wondering if we're still looking at September ETA?

DawgZter avatar Sep 20 '23 17:09 DawgZter

We want to move from short.io but waiting for API access.

srajelli avatar Sep 21 '23 20:09 srajelli

@DawgZter yes, but it's probably going to be closer to the end of September!

Also planning to roll this out in stages so if you haven't already, feel free to sign up for the beta waitlist here!

steven-tey avatar Sep 21 '23 21:09 steven-tey

Hi everybody ! Very very interested on migrating to dub.co with the future API.

I'be built a ChatGPT Plugin which short links and give possibility to have stats on these links. This plugin is managed with t.ly

But I really want to migrate on dub.co

So, I have some questions:

  • It's possible to migrate (existing links and stats) from t.ly to dub.co ?
  • Does API will offer possibility to pull stats of links ?

Thanks for all ! And for information, I had fill form to register on beta, I hope that I will be admit !

martinez-hugo avatar Sep 23 '23 07:09 martinez-hugo

That's awesome to hear @martinez-hugo!

  • It's possible to migrate (existing links and stats) from t.ly to dub.co? If the link is a t.ly link, that won't be possible. But if it's a custom domain, we can potentially build out a t.ly migrator to help you move your links over :)
  • Does API will offer possibility to pull stats of links ? That's the plan eventually, but in v1 we'll only allow for fetching, creating, updating, and deleting links. Will need to think more about the economics / rate limits for pulling stats since that can get expensive if abused.

steven-tey avatar Sep 24 '23 03:09 steven-tey

I'm 100% PRO-API!!

Please let me know if I can be of any assistance in testing this new feature. I'm a professional no-code developer using API's all around!

Thanks! 👍

patrickmast avatar Sep 24 '23 08:09 patrickmast

Good news – we just launched the Dub API beta today (sneak peek), with an estimated General Availability (GA) date of mid-October 2023.

If you are interested in joining the beta, please sign up for the waitlist!

steven-tey avatar Oct 03 '23 05:10 steven-tey

Will you be able to request metrics?=

mrloldev avatar Oct 18 '23 16:10 mrloldev

@MrlolDev not for the first version of the API, but potentially in future versions!

steven-tey avatar Oct 24 '23 16:10 steven-tey

Good news – we just quietly launched the public beta for Dub's API! Here are the docs: https://dub.co/docs

We're still planning to add a few more features to it before doing a public launch, more notably:

  • Bulk link creation
  • Tag creation & retrieval endpoints
  • Zapier integration

Will close this issue for now, but feel free to try out the API and send us any feedback you have via the in-app chat, email ([email protected]), or by creating a new issue :)

steven-tey avatar Nov 03 '23 05:11 steven-tey