Skip to main content
Version: 3.3.0

Webservice

Configuration​

In the config file: general/api config.json​

{
  "general": {
    "api": {
      "port": 3456,
      "users": [
        {
          "user": "runnerty",
          "password": "password_runnerty"
        },
        {
          "user": "usr_test",
          "password": "pass_test"
        }
      ],
      "secret": "RUNNERTY_SECRET_SAMPLE",
      "limite_req": "20mb"
    }
  }
}

Authentication​

Login to get the access token.

POST [/auth/]​

  • Body parameters
    • user (string)
    • password (string)
  • Sample (body)
{
  "user": "runnerty",
  "password": "password_runnerty"
}
info

All the API calls (except /auth/) must content the headers:

Content-Type: application/json Authorization: Bearer [TOKEN_RESULTANTE_DE_AUTH]

Check service status​

Returns http 200 if runnerty is working

GET [/health/]​

  • Sample (url) http://sample_host.com/api/health

Get chains​

Gets loaded chains

GET [/chains/]​

Get chain​

Gets chain

GET [/chain/:chainId/:uniqueId]​

  • URL parameters

    • chainId (Chain ID)
    • uniqueId (chain uId or execId)

  • Sample (url) http://sample_host.com/api/chain/CHAIN_SAMPLE

Force chain execution​

Executes the indicated chain if it is not runnning yet

POST [/chain/forceStart/:chainId]​

  • URL parameters

    • chainId (Chain ID)

  • Sample (url) http://sample_host.com/api/chain/forceStart/CHAIN_SAMPLE

  • Body parameters

    • custom_values (object)
      • GLOBAL_VALUE_KEY:VALUE_KEY (Global variable and custom value)

  • Sample (body)

{
  "customValues": {
    "YYYY": "1986",
    "MY_CONF_VALUE": "NEW_VALUE"
  }
}

Get a chain processes​

Gets the processes of a chain

GET [/processes/:chainId/:uniqueId]​

  • URL parameters

    • chainId (chain ID)
    • uniqueId (chain uId or execId)

  • Sample (url) http://sample_host.com/api/processes/CHAIN_SAMPLE

Get process of a chain​

Gets a process of a chain

GET [/process/:chainId/:uniqueId/:processId]​

  • URL parameters

    • chainId (Chain ID)
    • uniqueId (chain uId or execId)
    • processId (process ID)

  • Sample (url) http://sample_host.com/api/process/CHAIN_SAMPLE/PROCESS_ONE

CORS Configuation​

CORS API configuration parameters:

Options​

You can see the configuration options in the module documentation expressjs/cors

Sample:

{
  "general": {
    "api": {
      "port": 3456,
      "users": [
        {
          "user": "runnerty",
          "password": "password_runnerty"
        },
        {
          "user": "usr_test",
          "password": "pass_test"
        }
      ],
      "secret": "RUNNERTY_SECRET_SAMPLE",
      "limite_req": "20mb",
      "cors": {
        "origin": "*",
        "methods": "GET,POST",
        "allowedHeaders": "X-Requested-With,content-type",
        "credentials": false,
        "preflightContinue": false,
        "optionsSuccessStatus": 204
      }
    }
  }
}