While reading the documentation (API Resources) we try to use a consistent terminology for referencing resources & options. This is a guide to those terms used.
References a mobile only site, using the DudaMobile product. You can create, update, publish, un-publish and delete your mobile site via the API. To perform any design updates you will need to access the DudaMobile site editor that can be opened by logging into your Duda Account or (if you are a partner) by performing SSO into the White Label editor.
References a multiscreen site, using the DudaOne product, sometimes this is referred to as a responsive website also. You can create, update, publish, un-publish and delete your multiscreen site via the API. To perform design updates you will need to access the DudaOne site editor that can be opened via your Duda Account or (if you are a partner) by performing SSO into the White Label editor.
Duda has three main account types: Master account, Staff accounts and Customer accounts. Master account refers to your main Duda account which you have API access for. A Staff account is someone on your team that also needs to access the platform to build, edit or troubleshoot websites. Customers are your customers that access the white label platform, this is the most common account type you create with the API.
Access analytics for a specific site. The site can be either DudaOne or DudaMobile. Duda automatically collects analytics data for each site published on the platform.
A list of mobile user agents that get redirected to the mobile website. DudaMobile maintains this list and updates as OS changes and new phones come on the market. You can use this to match User Agent Strings to redirect mobile visitors to the mobile site. Note: DudaMobile does not redirect for tablet devices.
Site Management Terminology
The terms used to manage a site via the API.
Create a new mobile or multiscreen site in your account.
Duda allows you to pass additional data about the site during the creation of the site. If you pass data, Duda will use this during the creation of the site to improve starting point of the site. If you give Duda a Facebook URL or existing website, we will import content from that resource. Mobile site import and Multiscreen site imports are slightly different, so please note the differences and plan accordingly.
Get Site Information by Site Name:
Get data about a specific site. You can get information such as domain value, business information Duda found, and more.
Get Site Information by ExternalID:
When creating a site, Duda allows you to provide an external ID. This would reference a resource on your side to associate with this newly created site. This can be an easy way to access resources on the Duda side, depending on the d
Update the information about a site that is already created. The most common use case for this is updating a site's domain values.
Recreate (or reset) an existing site. This is only available for mobile sites currently, but it will reconvert the site. Please note that doing this will reset any design changes already made to the site.
Delete an existing site. This will cancel any subscription associated with the site and make it no longer available. After a site has been deleted there is no way to get the site back.
Publishing is one of the most common actions taken on an existing site. Publishing a site is taking a site live to use as a real website. Before publishing, the site is only in a design mode that cannot be readily accessed by the world. By publishing a site you are creating a new subscription for the site and statistics will start being tracked for visitors that come to the site
Take the site offline so it can no longer be accessed publicly. The site will revert into design mode where it can still be edited, managed and published again later. The most common use case for this is taking a site down but not wanting to fully delete it. For example, if a customer does not pay their recurring monthly fee, you can un-publish the site until they have renewed with you.
Clear a Published Sites Cache:
For live published sites, Duda caches the content of the site to improve performance and reduce server resources. This might cause a scenario where a mobile site is not auto-syncing the latest content from the desktop website. To check if this is the case, you can clear the cache of the site
Get Sites that were created during:
Return a list of sites that were created during a specific time range. This can be used for mobile and multi screen sites, but require different calls to do so.
Get Sites that were accessed or edited during:
Return a list of sites that were accessed or edited during a specific time range. This means the site's were logged into and edited recently, a good indicator of activity taken on the site.
Get Multiple Sites:
Get information of multiple sites at once. This returns the same content as the Get Site Information by Site Name, but allows you to get many of them at once.
Allows you to duplicate an existing site in its current state. All design changes will be copied to the new site. This is available for mobile and multiscreen sites.
Get Form Submissions:
While building sites, Duda has a contact form feature that allows site visitors to submit information to the site owner. Using the API, you can get the raw data about the contact forms that were submitted on this site. This way you can present this information how ever you would like.
When creating a multiscreen site, you need to provide a template_id number as part of the site creation. Duda has many templates to choose from. Using the Get Templates, you can display a list of available templates to choose from. Duda adds new templates often, so the list will continue to grow over time.
Inside of the mobile and multiscreen site builders, Duda provides an easy way to create backups of sites. This saves the site as it is at its current point in time. Additionally, upon publish, Duda saves the current version of the site. We allow you to manage these backups via the API. A good use case of this would be to create a new backup before a user starts editing a site, incase they want to restore back to a certain point in time.
Account Management Terminology
All account level items are only available for Duda Partners. Regular account holders do not have access to the account level resources.
Create Customer Account:
Create a sub-account for a user of yours. In order for someone to access the White Label portal, you must create an account for that customer. This is a sub-account that exists only under your master account.
Get Account Information by Account Name:
Get the information about a specific account that has been created.
Update the information about a specific account that has already been created. Useful for updating email address and names.
Grant Site Access to Sub-Account:
Give a specific sub-account access to a specific mobile or multiscreen site. This must be done in order for a customer of yours to access the White Label editor.
Revoke Site Access to Sub-Account:
Remove access to a specific site for a specific user. This only works if the user has already been granted access to the site.
Get Sites by sub-account
Retrieve a list of sites that a sub-account has access to. This will tell you all sites that a certain user might want to access. Useful for building a 'dashboard' of sites available to a certain user.
Get Site Analytics:
Allows you to retrieve a website's traffic analytics for a given time period. This will return a total number of visitors over the specific date range.
Get Sites with most Traffic:
Allows you to retrieve websites' traffic analytics for the sites with the most traffic over a given time period.
Get Supported Agents
Allows you to retrieve a list of mobile user agents supported by the mobile sites platform. If you have control over the desktop site, we strongly recommend setting up the redirect for your visitors automatically. You can use this API to retrieve an updated list of user agents to match against desktop site visitors.
White Label Editor/Dashboard
DudaPro partners have the option of providing their customers with a White Label version of the mobile site (DudaMobile) or miltiscreen site (DudaOne) editors. This allows them to log in to a dashboard/site editor with your own branding. You can log them in by creating a sub-account for them and giving access to a specific site. Once logged in, they will be able to access the dashboard, site editor(s) and any analytics/statistics for published sites.