About

The Eclipse API is used to return and manipulate data for use by the Eclipse Web Integration system. The API is built using the RESTful principles.

REST General Principles

All of our rest objects will be exposed using the standard HTTP Verbs as per the following table.

Resource	POST	GET	PUT	DELETE
/{resource}	Creates a new instance of the specified resource.	Retrieves a list of the specified resource type.	Updates the resource collection.	Deletes all the resource collection.
/{resource}/{uid}	Error.	Retrieves a specific instance of the resource.	Updates the resource with the specified uid.	Deletes the resource with the specified uid.

Web API Url

All of our rest objects will be exposed using the standard HTP Verbs as per the following table.

https://{host}/api/{version}/{resource}/{uid}

For example, if you wanted to get a list of published jobs by the industry for a specified portal, the URL would be:

https://api.recruitment-websites.co.uk:8181/api/v1/portals/ea8d5d89-a94e-48d9-837e-122fabd86461/jobs/industries

Request Headers

All requests sent in to our API require you to specify the following values in the header, otherwise a 401 Unauthorised HTTP status code will be returned.

API Key

The portal GUID (globally unique identifier) supplied to you by Eclipse.

ApiKey: 0E91656C-007F-4c0f-BBEF-882915840F86

API Password

The API password used to log into the specified portal.

ApiPassword: password123

Authorisation

Additionally, on resource requests that require an authenticated user. This should be supplied in Base64 encoded format (e.g. username:password ). This header value is not required for anonymous API calls.

Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

All other parameters should be passed into the request body as serialised JSON. All returned values will also be returned as JSON/XML by defining the Content Type request header.

Content-Type: application/json
Content-Type: application/xml

Version

The current version of the Eclipse API is version 1. Methods may be deprecated but still available to use. Any new API method calls will have a new version number. To call a specific version specify the version number in the API method call route prefix.

GET /api/v{versionNumber}/countries