Skip to main content Link Menu Expand (external link) Document Search Copy Copied
MTAP

RESTful API Gateway

Running and using the MTAP API Gateway.

Configuring the API Gateway

The API Gateway supports either specifying the addresses that it re-hosts in configuration, or using service discovery to find services to re-host.

To configure the API Gateway we will create a mtapConfig.yaml file in the working directory of the API Gateway binary.

Specified addresses: 

discovery: consul
consul:
  host: localhost
  port: 8500
  scheme: http
  # Python uses {python_naming_scheme}:address[:port][,address[:port],...] as grpc targets
  python_naming_scheme: ipv4

gateway:
  port: 8080
  refresh_interval: 10
  events: localhost:9090
  processors:
    - Identifier: mtap-example-processor-python
      Endpoint: localhost:9091

Using service discovery: 

discovery: consul
consul:
  host: localhost
  port: 8500
  scheme: http
  # Python uses {python_naming_scheme}:address[:port][,address[:port],...] as grpc targets
  python_naming_scheme: ipv4

gateway:
  port: 8080
  refresh_interval: 10
  events: null
  processors: []

Running the API Gateway

To launch the API Gateway, use one of the provided executables:

./mtap-gateway-v1.2.1-linux-amd64

Using the Events API Gateway

Creating an event 

curl -X POST localhost:8080/v1/events/1

Setting and retrieving metadata 

curl -d '{"value":"Value"}' -H "Content-Type: application/json" -X POST localhost:8080/v1/events/1/metadata/key

Getting all metadata:

curl -X GET localhost:8080/v1/events/1/metadata

Adding a document 

curl -d '{"text":"This is some document text."}' -H "Content-Type: application/json" -X POST localhost:8080/v1/events/1/documents/plaintext

Retrieving document text 

curl -X GET localhost:8080/v1/events/1/documents/plaintext

Adding labels

Create a file, labels.json:

{
  "json_labels": {
    "is_distinct": true,
    "labels": [
      { "start_index": 0, "end_index": 5, "x": "value"},
      { "start_index": 6, "end_index": 20, "x": "value2"}
    ]
  }
}

Uploading the labels:

curl -d @labels.json -H "Content-Type: application/json" \
-X POST localhost:8080/v1/events/1/documents/plaintext/labels/new_index

Retrieving Labels 

curl -X GET localhost:8080/v1/events/1/documents/plaintext/labels/new_index

Using the processing API Gateway

Listing all available processors 

curl -X GET localhost:8080/v1/processors/

Calling an event processor 

curl -X POST localhost:8080/v1/processors/{processor_id}/process/{event_id}

Calling a document processor 

curl -d '{"params": {"document_name": "plaintext"}}' -H "Content-Type: application/json" \
-X POST localhost:8080/v1/processors/{processor_id}/process/{event_id}

APIs