Add-ons: getting started
If you are reading this you have probably finished developing your add-on. That’s great news. The DNSimple team is looking forward to seeing what can be achieved with your creation!
Since your add-on is ready for production, you should switch from the Sandbox Environment to
dnsimple.com. Even though you could simply update the configuration, we strongly advise you to deploy a new instance of your add-on. You can keep the existing one as the environment to debug issues or test new features.
Now that your add-on is ready for production, make sure to double-check the requirements that it must fulfill to be added to the catalog. If you only had an account on the Sandbox Environment you will now have to create one on
Simply follow the same steps to create an OAuth application on dnsimple.com instead of the Sandbox Environment. Make sure to update the configuration so the add-on uses the new production
Since your add-on was using the Sandbox Environment, you should now update the configuration to makes calls against
If you are using one of the official API clients, update the
base_url setting to:
Make sure to do the same for any other API your add-on interacts with.
Each add-on must use a custom
User-Agent header for DNSimple API calls. This will help us verify that your add-on behaves as expected.
User-Agent header is easy if you are using any of the official API clients:
User-Agentheader using the Ruby API client.
User-Agentheader using the Elixir API client.
User-Agentheader using the Go API client.
User-Agentheader using the Node API client.
Once your add-on is production ready you can choose to publish it on the DNSimple catalog. If your add-on is for personal use or company use you can skip this section completely. Just in case, here are some reasons why you may choose to submit your add-on to the DNSimple catalog.
This is the configuration data, copy, and artwork that you have to provide to publish your addon:
client_id of the production OAuth application. Remember to edit the application details as these are displayed to users during the authentication flow. They should be consistent with the copy for the catalog.
The name of your add-on. Please keep it short.
A brief description of what your add-on accomplishes.
A detailed explanation of the add-on features. What it can be used for, the services the add-on interacts with, the tasks it automates, etc…
100x100 pixel image to use as your add-on icon.
Add-on cover screenshot
1280x800 pixel screenshot to use as the first image of your add-on.
Add-on extra screenshots (Optional)
Up to 9 more
1280x800 pixel screenshots of your add-on that are helpful to understand what it accomplishes.
Once you have put together all this information, send it to email@example.com. We will review your submission as soon as possible and work with you to get it on the DNSimple catalog!