Quick start
Overview of steps required to create an App
To create an App you only need basic development knowledge.
You are not limited to a specific programming language, only to the possibilities granted via Ergonode by its communication interfaces.
To develop a functional App you only need to follow a couple of simple steps.
Create a Manifest
Firstly, you need to provide a Manifest - a simple JSON file determining the basic App behavior and possibilities it is utilizing.
The file is required for the app registration process for the New App to display in your available apps tab.
Prepare authentication
Next up it's essential to keep your data safe. To achieve that you should have a functional authentication system.
The App has to be able to identify itself so that Ergonode will know it can perform the API operation it is trying to execute. It is also crucial that when the App receives a request it can determine whether it comes from a trustworthy source.
On App installation, Ergonode exchanges handshake with App with data allowing authentication of the following requests performed, assuring that no 3rd party is tempering the data.
Handle your configuration
Some Apps require dedicated configuration. Once provided by Manifest App users will be able to set up their App within Ergonode to make it work appropriately to the installation needs - App should validate and persist your configuration.
Implement event endpoints
If your App needs to know about basic events create specific events handling.
Implement your business logic
It is up to you what exactly the App will do.
Implement synchronization endpoints
This step is optional and depends on your intent.
Synchronization endpoints reference
If your App is meant to generate a file, integrate the data into the eCommerce system, or has a similar purpose forcing having the long-running process to handle all of the data, rather than implementing the entire synchronization yourself, let Ergonode orchestrate the process and focus only on the development of your business logic.
Host your application
Host your application on an HTTP server of choice.
For development and testing use tools like ngrok to make quicker code iterations.
Ergonode currently does not provide hosting for custom Apps.
Register your App
Once all set up register your App in the available apps tab.
To refresh the App Manifest, it has to be changed and reapplied just like on App registration. Ergonode does not refresh it automatically.
Remember also, on refreshment, to raise the version - otherwise, changes won't be applied as described in the version restrictions description.
Last updated
