Creating a Service Manually

Add a new REST API web service to a KnowledgeKube repository through the Service Workbench.

Implementation:

  1. Click to access the Service Workbench tab.
  2. Select the provider to which you want to add the service.
  3. Open the Service Options menu and select Create New Service. This opens the Create Service dialog where you can configure the service.
  4. Use the Service Name to enter the service's name.
  5. (Optional) The Service Reference field automatically fill to match the Service Name you entered. However, you can edit this if required. The Service Reference is used when calling the service using the WorkbenchRequest function.
  6. Provide a Service Description that explains the purpose of the service for the benefit of yourself and other back office users.
  7. Enter the service's website address in the Service Web Page URL field.
  8. (Optional) Click the Test URL button to open the website in your default browser to ensure it is correct.
  9. In the Category tab, choose which category to assign the new service. If at least one category already exists, you can choose one from the Pick a Category From the List Below drop-down menu. Alternatively, you can select Create and Use a New Category and enter the name you want to give the new category in the provided text field.
  10. Switch to the Service Parameters tab.
  11. Add all the Parameters required by the service, along with their values. The parameters determines what the service does and how its functionality is executed, so these will differ depending on the API service you are using.

Many RESTful API web services will provide reference documentation for which parameters and values are required. For example, you can find comprehensive information about Microsoft's API services in their reference catalog.

  1. Click Create to confirm the creation of the new service.

At this stage, you will be asked if you want to add Operations to the new service. Choosing No will just create the service and return you to the Service Workbench. However, selecting Yes will open the Manage Operations screen where you can add and edit operations.