WorldServer documentation for software developers
In WorldServer, software developers can enhance standard functionality through the Software Development Kit (SDK), manage integrations via web services, or customize the user interface by adding new buttons, messages, or other elements.
Working with the Software Development Kit (SDK)
The Software Development Kit (SDK) provides a stable, clearly defined layer of APIs for enhancing standard WorldServer features and for integrating WorldServer with other custom or third-party applications.
By using the WorldServer SDK, you can implement and manage your own extensions in-house. In other words, you can have complete control over WorldServer customizations.
You can find the SDK installation archive in the WorldServer distribution kit. The archive contains the following: the libraries that you need to create and compile SDK applications, Java documentation for the SDK, additional documentation, and sample code that illustrates how to create WorldServer SDK applications.
You can use the sample tools and components included in the samples directory to find out how to make the most of the WorldServer SDK.
The following services are supported primarily through the APIs of the WorldServer SDK. Many of them, however, are also exposed through web services. You can also create custom web services in the SDK, which gives you great flexibility in integrating with WorldServer.
An overview of the WorldServer environment, components, objects, modules, and services that you can access with the SDK.
Custom access modules are programs or components that have been developed by using the WorldServer SDK. You can create two types of custom access modules: external service modules and component modules.
A brief description of the components supported by the SDK. Most of the content that might be relevant for developers is provided in the package and object-level Java documentation. The SDK also includes documented samples for each supported component.
You can configure several types of non-component objects both through the WorldServer user interface and externally, through the components archive.
An overview of the SDK components that make up the web service resources.
An overview of the sample tools and components that provide models for customizing web services.
The WorldServer REST API
As of version 11.0, WorldServer contains an API based on modern standards (REST and JSON), implemented using the Spring Framework. It uses standard HTTP methods such as GET, POST, PATCH, or DELETE and provides a new layer of security to the WorldServer 11 interface, which is built on top of it.
An overview of the main changes made to the REST API in WorldServer 11.7.
Some operations that use the WorldServer API are more complex than others. Before you make a request, you might need to obtain certain information through other requests. For example, before you can complete a task step, you need to find out the ID of the transition to the next step. The topics in this section present the requests you need to make and the order in which you need to make them to perform a series of common operations with the WorldServer API.
Find out what endpoints you can call and what methods you can use to call each endpoint. You can also find sample calls, potential error messages, and a response for each call.
Add custom endpoints to the new REST API by using the existing WorldServer SDK. However, you should use this only as an entry point into the REST API and delegate the customization logic to other classes.
Customizations for the WorldServer user interface
By using the customization SDK, you can develop user interface elements for various scenarios, such as adding a button on the ribbon, having a dialog box displayed, or customizing a task completion screen. From a technical standpoint, you can add a customization anywhere on the WorldServer user interface. However, doing so without a customization SDK would be difficult and not recommended. As time passes by and the user interface changes, the customization SDK helps you to manage your own customizations and to maintain a certain level of consistency with the standard WorldServer interface. Note: The customization SDK refers to a set of options that you have when customizing the interface. It has no representation within the actual SDK in the WorldServer distribution kit.
The customization SDK contains several UI controls that you can inject as require dependencies. These controls are located in the sdk/controls/
The customization SDK contains several UI services that you can inject as require dependencies. These services are located in the sdk/services namespace.
Links to sample UI customizations that you can download, add to a test environment, and use as starting points for your own customizations.
Starting with version 11.1, you can implement and manage UI customizations directly from WorldServer by logging in as an administrator and typing the following in your browser's address bar: