Please look in the TERMINOLOGY section for the definition of any words in bold.

The DOME API will allow you to complete goals in the form of assessments for your entities.

The main goal within the DOME API is the LifeCurve, this goal can tell you where your position is on the LifeCurve, and could recommend further goals to take in order to help you.

During this process, you will also have an organisation created for you, your organisation public id will be referenced when making assessments this is so we can identify who assessments are being created for.

In order to start using the DOME, you will need an application, each application will have it's own set of credentials for authenticating with the DOME, having a set of credentials per application is helpful to us and you for tracking where traffic is coming from.

Once you have a set of credentials, you can use these to authenticate with the DOME, each time you authenticate you will be given a Bearer token that expires 30 minutes after it was requested.

Now you have your Bearer token it can be sent in a 'Authorization' header, we advise also sending an 'Accept' header with the value of 'application/json', this will guarantee a json response.

Now you can interact with the DOME, in order for you to start using the DOME, you will need an entity, each entity will be unique per person in your application. When you hit the create entity endpoint, you will be given a unique entity public id, this will be saved so it can be used again later. The main purpose of the entity public id is to allow previous answers to be remembered.

With an entity you can create an assessment from a goal, providing the entity public id, goal id and your organisation id to the create assessment endpoint.

With an assessment, you can then pull the questions for it from the questions endpoint. The questions endpoint will give a list of questions that must be answered before progressing, and may provide a list of possible answers depending on the type of question, if not you can answer with a value within the provided range.

When all questions have been answered, you can trigger then matching process, which will then tell you how to proceed. If you get an assessment resource back, this means you have another set of questions that need to be answered, these can change depending on how the previous set of questions were answered. You can also get a success true message, which means the assessment is complete and you can pull the results for it. Or you could get a success false message, which means the assessment has completed, but no results were found.

Now you should be able to pull the results for your assessment, in your results you could be given any combination of the following : Product, Movement Routine, LifeCurve Position, Helpful Tips , FAQs ,Important Information, Services, Advanced Movement Routine, Related Goals, Product Related Advice.