Getting Started

The Basics

The EnterWorks APIs can be accessed with any programming language that supports network programming around the HTTP protocol. The base URL for the EnterWorks APIs is:

http://<webhost>/webcm/rest/api

What do the APIs do?

The EnterWorks APIs provide an extension that allows third party applications to integrate with the EnterWorks system. These APIs provide access to the EnterWorks functionality by sending code requests rather than using the screens in the browser-based user interface (UI). However, they are not an alternative to the UI since they lack the administrative capabilities such as user, security, and repository mapping management.

Authentication

Your browser uses cookies as a means of authentication.

Authorization

EnterWorks APIs require authorization before you can use them. To test the APIs, you must first use one of the following methods to generate an authorization token:

• Authorize Using a Token

• Authorize Using JavaScript

Test Your Setup

You may want to test your setup to make sure you can call the EnterWorks APIs. Open the command line editor on your computer and enter:

curl -v http://<webhost>/webcm/rest/api/groups

This command will not return any records since the token is not being passed, but it will indicate if you are able to call the APIs based on the Connected to <webhost> value in the response.