Add-ons: getting started
An add-on is a web application that integrates with the DNSimple API to simplify connecting domains with other web services, adds functionality to DNSimple, or enhances the experience of DNSimple customers in other ways. Add-ons can be written in any programming language and are deployed and operated by developers independent from DNSimple. Any developer may build an add-on that integrates with DNSimple following the documentation provided on this site.
To get started, you may want to review our “Getting Started” guides for Ruby, Elixir, Node, or Go. These guides will walk you through the basics of connecting to the DNSimple API, authenticating, and getting a list of domains in an account. Each guide includes example code so you can follow along in your development environment.
If you use a programming language that doesn’t have an official DNSimple client yet, don’t worry! You can still build a fully-functional add-on by communicating directly with the DNSimple REST API from the language of your choice. The add-on reference documentation will guide you through the requirements for add-ons, how to authenticate using OAuth, and how to make authenticated calls to the DNSimple API.
Once your add-on works you can use our style guide, including preconstructed CSS and JS, to help make your add-on beautiful quickly. You can also style your add-ons in whatever way you see fit with your own CSS.
We’ve also provided a collection of example add-ons that we’ve built so you can see how it’s done.
Finally, once your add-on is ready, follow the submission guide to get your add-on into the DNSimple add-on catalog, and in front of thousands of DNSimple customers.
Your imagination is the only limit to the add-ons you can build. In case you need some inspiration, here are some ideas:
Configuring existing monitoring services is painful. You have to go through and add each domain you want to monitor, as well as tell the service what kind of monitor should be set up. And if you change your domain configuration, you have to go back and manually update the monitoring service.
You could build an add-on that retreives a customer’s domain list, shows them what domains are already monitored from the list, and provide an easy way to enable monitoring on a domain. You could take the add-on further by automatically detecting what services are running on a domain using their zone records and then offer to enabling montoring for those services with a single click.
Connecting a custom domain to hosting platforms is a drag. You have to understand what the hosting company provides, get the right addresses and manually add them to a domain. If the hosting company ever changes the address then you have to go in and manually fix them and your site may go down in the meantime.
You could build an add-on that automatically connects a domain to a hosting service. Your add-on could automatically configure the zone in DNSimple and set up the configuration in the hosting service. And when the address changes your add-on could automatically update the record in DNSimple without ever needing manual intervention.
The internet is a dangerous place! Each year we hear about more breaches from high profile companies. In many cases this could be avoided with the proper preventative steps, including understanding where your security vulnerabilities are so you can fix them.
You could build an add-on that automatically analyzes domains in your DNSimple account to detect security vulnerabilities. No need to configure the security tool, just pick a name from your list and provide an in-depth analysis.
Email deliverability is hard. Companies spend tens of thousands of dollars, if not more, trying to ensure that email arrives in their customers’ inboxes. Often this involves tweaking DNS configurations to ensure messages are not marked as spam.
You could build an add-on that analyizes a customer’s domains and provides guidance on how to improve email deliverability. Integrate with DKIM and SPF analysis tools and find out where problems exist before customers are impacted and email fails to be properly delivered.
It’s ok to just have fun. You could take the classic game of hangman and build an add-on that uses domains from DNSimple accounts as the words.