Platform API

Nexus exposes a uniform consumer RESTful interface over HTTP(S). The generally adopted transport format is JSON based, specifically JSON-LD. The Edge component routes requests to the appropriate services based on the intent of the caller and a content negotiation scheme.

An additional interface for asynchronous communication is exposed over Kafka’s protocol internally in the same format.

Individual service API refences:

Error Signaling

Services make use of the HTTP Status Codes to report the outcome of each API call. The status codes are complemented by a consistent response data model for reporting client and system level failures.

Format
{
  "@context": {
    "@vocab": "{{base}}/voc/nexus/core"
  },
  "code": "<a machine readable unique code>",
  "message": "<a human readable description of the error>"
}
Example
{
  "@context": {
    "@vocab": "{{base}}/voc/nexus/core"
  },
  "code": "IllegalFilterFormat",
  "message": "Unable to parse 'path' as an uri",
  "field": "DownField(filter)/DownField(path)"
}

While the format only specifies code and message fields, additional fields may be presented for additional information in certain scenarios.

The source code for this page can be found here.