Add this line to your application's Gemfile:
gem 'relinkly'
And then execute:
$ bundle
Or install it yourself as:
$ gem install relinkly
If using Rails, put the following into your application.rb. If just Ruby, run this before trying to use the API.
Relinkly.configure do |config|
config.api_key = 'YOUR_KEY_HERE'
end
api = Relinkly::API.new
api.domains # GET /v1/domains
api.domain(id) # GET /v1/domains/:id
api.domain_count(options) # GET /v1/domains/count
api.account # GET /v1/account
api.workspaces # GET /v1/account/workspaces
api.tags # GET /v1/tags
api.tag(id) # GET /v1/tags/:id
api.tag_count(options) # GET /v1/tags/count
api.new_tag(options) # GET /v1/tags/new
api.update_tag(id, options) # POST /v1/tags/:id
api.delete_tag(id, options) # DELETE /v1/tags/:id
api.links # GET /v1/links
api.link(id) # GET /v1/links/:id
api.link_count(options) # GET /v1/links/count
api.new_link(options) # GET /v1/links/new
api.shorten(destination, options) # POST /v1/links
api.update_link(id, options) # POST /v1/links/:id
api.delete_link(id, options) # DELETE /v1/links/:id
api.tags_link(id, options) # GET /v1/links/:id/tags
my_domain = api.domains.first
link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage')
Please see the applicable methods for options available when making requests. You need to pass the workspace_id in the options as follows in case you want to perform operations other than the default workspace.
Here's how you can create a link into another workspace.
my_domain = api.domains.first
my_workspace_id = api.workspaces.first.id
link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage', workspace: my_workspace_id)
Please note that my_domain
should already be included inside my_workspace
. Similarly other operations on link and tags can be achieved as above.
You can find all the details about your workspace by going here. https://app.rebrandly.com/workspaces
Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/relinkly.
The gem is available as open source under the terms of the MIT License.