After you've published your application, you probably want to test your endpoint :-)
Navigate to Calculate Hash in the main navigation.
Select your endpoint and the environment.
In case your endpoint has "include-in-hash" parameters, you will be prompted to enter values for those parameters. See: Authentication.
Press button Calculate Hash and copy the calculated hash value.
Navigate to Home in the main navigation.
Copy Live URL or Preview URL - depending on what environment you would like to use. The URL should look like this: https://endpoints.openendpoints.com/foo/{endpoint}?{parameter}
Replace {endpoint} with the name of your endpoint
Replace {parameter} with: hash=[the-calculated-hash]
If your endpoint has "include-in-hash" parameters, those parameters (and the values as used for calculating the hash) shall be added as additional GET parameters.
Copy the link into your browser.
Navigate to Request-Log in the main navigation. You will find your request, including additional information in case an error has occurred.
The term ”application” is used to describe a piece of configuration. OpenEndpoints can serve multiple applications simultaneously. You can create different projects with different application directories and run them in parallel.
An application is configured with a directory of files - mainly XML files. The structure of the directory is explained in detail here: Application Directory Structure.
OpenEndpoints pulls the application directory from a Git. When publishing, the last version is pulled from the Git and your configuration is updated.
Click Add New Application to create your first application.
This will open the screen to add new or edit existing applications:
Choose an application name, which will become part of the endpoints URL
The Display Name is used in the user interface and will also be available as an input-from-application in Parameter Transformation.
The Git URL shall point to the root folder of your Application Directory Structure.
After successfully adding a new application you will find your new application in the "Change Application" Screen:
The process to publish an application requires 2 steps:
Commit changes in your application directory to Git
Use the "Publisher" to pull the latest revision of your application into the software.
Open the application you want to publish:
Navigate to "Publish" in the main navigation. The Publisher lets you publish the latest version of your Git to Preview or Live Environment - see: Environments.
This option will:
Load the latest available revision from your Git repository
Check the new configuration for consistency and errors. If an error is found, the new version will not overwrite any existing status. A detailed description of the error is displayed.
On success the new revision will replace the previous configuration.
Promote Preview to Live
This option will not pull a new version from the Git, but simply copy the existing configuration from Preview to Live. No further check of consistency is required, as this had been done already when publishing that version to Preview.
OpenEndpoints installed in "Multi Application Mode" (see Deployment Modes) comes with a service portal for administration:
https://[your-base-url]/service-portal
Note that in "Single Application Mode" your application is already packed with the Docker container.
A default account for the admin is automatically created during installation:
Security Alert
Don't forget to set a new password as soon as possible!
