Developers Portal Guide

With the developers portal we wanted to provide an easy way to create and manage applications that integrate with the HAT. In short, it offers:

  • Creating an account that can be used to manage applications
  • Creating a testing account that can be used in order to interact with applications during testing
  • Creating a new application
  • Updating/editing an existing application
  • Submitting the application for review in order to be released to everyone in the HATDeX platform
  • Creating test application to test new features without affecting the application that is already available to the public
  • Deleting/removing applications
  • Offering support to achieve all the above either by documentation/guides or by contacting us directly

Signing up with new HAT

Account creation can be achieved by clicking Create account in the top right corner of the page here.

Home Screen

The fields required to create an account are:

  • first name — First name of the main developer
  • last name — Last name of the main developer
  • email — Email that will be used for this account. It has to be a valid email else the account verification will fail
  • username — A valid username. Usernames has to start with a non capital letter, do not contain special characters and be 4-21 characters long
  • terms of service — In order for the account creation to continue it's vital to agree to the terms of service
  • Company — Company name is optional and can be filled at a later point
Please note that email and username must be unique and not used before to create a HAT, otherwise,
the process will fail. Also the company name must be unique within Developers portal.

Sign up

After filling out the information needed, click Next in order to create a password for the new HAT account. The password must achieve a strength rating of good or above otherwise the process will not continue. You can find our password policy here.

Password

In the next screen after clicking Next the Developers Portal application will ask permissions to have access to the new HAT account

Permissions

Finally, click Confirm to create the new HAT.

Signing up with existing HAT

Existing HATs can be also used to log in. Just click Create account in the top right corner of the screen and then click Already have a HAT? Start Here button.

Please note that only hubofallthings.net HATs are accepted at the moment.

Sign up existing

Then enter the hat's username, eg for myusername.hubofallthings.net enter myusername, and click Next. If the HAT has been found the "enter your password" screen will be shown else if the HAT has not been found an error will be shown.

Finally, in both cases, signing up with existing or new HAT an account verification will be needed via an email which is sent instantly after the successful registration.

Log in

To log in click Log in in the top right corner of the screen.

Log in

Then enter the hat's username, eg for myusername.hubofallthings.net enter myusername, and click Next. In case the HAT has been found the password screen will show. Please enter the HAT's password. Otherwise, the HAT has not been found, please contact us if you believe this is an error.

Onboarding

After your email has been verified, a two-step onboarding process will start.

Onboarding1

The first step contains information about the testing HAT that has been created and the password attached to it. A testing HAT is useful during and after the development of the application. It grants the ability to test the application in a separate HAT than the main HAT that's been used to access the developer portal. This is to enforce a separation of the accounts that will be able to manage the application and the accounts that will be used to test the application.

The second step asks for information about the organisation. It's an optional step and it can be skipped. It can be filled at a later point.

Onboarding2

Create the application

Creation of a new application is possible with the blue Create button in the top right corner of the screen in My Apps section

Create app

A new window with all necessary information needed to create a new application will appear. This list contains:

  • Application name — A human-readable name of the application. It can be the same with other applications
  • Application website — A URL where more information about the application can be found
  • Application id — A unique application identifier. Must not contain spaces or special characters
  • Application namespace — The unique application namespace. This will define the domain under which the application will be able to read/write data. Must not contain spaces or special characters
  • Country — The country that this application is developed
  • Platforms — The platforms this application will support. Currently, we offer 3 options web, iOS and android

For each platform selected 2 additional fields will be requested. More specifically:

  • Application link — A URL that users can learn more about the application
  • Callback URI — A callback URI that will be used during authentication with the HAT

Create App information

Please note that the new application can take up to 30 minutes to be visible in the HAT

Updating or submitting application

By clicking any application under My apps section it's not only possible to see all the information about it but also edit the application under certain conditions.

App dashboard

Please note this image also showcases how its possible for two applications to have the same name
by having different application ids.

By clicking an application is possible to fill even more fields than before:

  • Application name — A human-readable name of the application. It can be the same with other applications
  • Application website — A URL where more information about the application can be found
  • Application description — A description of what the application offers to the users
  • Support email — An email users can ask support if there is a problem with the application
  • Privacy policy URL — A URL where users can see the application's privacy policy
  • Terms and conditions URL — A url where users can see the application's terms and conditions
  • Platforms — The platforms this application will support. Currently, we offer 3 options web, iOS and android
  • Application namespace — The unique application namespace. This will define the domain under which the application will be able to read/write data. Must not contain spaces or special characters
  • Country — The country that this application is developed
  • Rating — A 3 lettered system indicating how the application uses the data
  • Logo — The logo of the application
  • Screenshots — The screenshots of the application

For each platform selected 2 additional fields will be requested. More specifically:

  • Application link — A URL that user's can learn more about the application
  • Callback URI — A callback URI that will be used during authentication with the HAT
Please note that in order to submit an application for review, all of the fields must be filled.

Once the necessary changes have been made, clicking Save in the bottom right corner of the screen will save the changes without Submitting the application.

Submitting an application is possible by clicking the Submit button. Please note that any changes must be saved first in order to submit the application for review. After submitting the application for review, a new one will be created for test purposes. Please use that one from now one to make any further changes/updates to the application. By creating a second, separate, application we ensuring that any changes made will not affect the current live application.

App full information

Pushing an update

After submitting the application, the application will lock and it will not be possible to make any more changes. Any changes from this point onward will have to be done in the test application. In order to submit a new version of the application, just submit the test application for review. The currently live one will be replaced by the new one once a manager approves your update.

Deleting app

Deleting an application can be split into 2 sections. Deleting an application that is currently in a Draft state is achieved by tapping the Delete button in the bottom left corner of the screen.

App full information

Deleting an application that is currently Live needs approval by a manager. The process is the same as before with an additional review from a manager. You will receive an email when the manager deletes your application.

Please note that deleting an application that has a test application attached, will result in both
applications, test and live, getting deleted.

App rejections or suspensions

A manager can reject or suspend an application at any time. This can be due to problems with the application or for security reasons. A rejection or suspension message will be sent to your email with more information about the reason that led to this.

App statuses

The possible application statuses are:

  • draft — Application not submitted for review yet. It's currently live in the staging environment, hubat.net and able to be tested with a hubat.net HAT
  • test — This application is the test version of a currently review or live application. Its purpose is to provide a testing ground for further updates to the live application.
  • review — Application has been submitted for review by a manager.
  • live — Application is currently live on all HATs
  • rejected — Application has be rejected. Please look at your emails for further details as to why it has happened.
  • submitted — Application has be suspended. Please look at your emails for further details as to why it has happened.
  • deleted — A live application needs to be deleted. A manager will look at the request and delete the app. An email will be send to confirm the deletion of the application.

Editing account information

Accounts Settings section holds the basic information of user/organisation. Some information is possible to edit and some not. The following can be edited at any time:

  • First name — Developers first name, stored in the HAT
  • Last name — Developers last name, stored in the HAT
  • Personal website — Developers website, stored in the HAT
  • Company — Company name. This has to be unique
  • Country — Country the company is based
  • Company website — Company's website URL
  • Company logo — Company's logo

Other information provided in this section includes:

  • Partner Id — Your partner Id, automatically generated on sign up
  • UsernameHAT username
  • HAT URL — The full URL of the HAT
  • Email — Email used when signing up
  • Password — Reset password option

Organisation info

Test account information

During sign up a test account is created. The test account credentials can be found under Test roles.

Please note that the test account will always be hubat.net account

Testing Roles