Capabilities

Register a new REST integration

put/epos/integrations/rest

Request

Base URL
https://api.dojo.tech
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/dojo/apis/dojo-api/docs/epos/integrations/rest/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

urlstring required

Example request

{
  "capabilities": [
    {
      "name": "GetOrderById",
      "version": "v1"
    },
    {
      "name": "RecordOrderPaymentById",
      "version": "v1"
    }
  ],
  "url": "https://my-epos.com/orders",
  "auth": {
    "authType": "basic",
    "basic": {
      "username": "epos-1",
      "password": "hunter2"
    }
  }
}

Response

Successful operation

urlstring required

createdAtstring date-time required

Example response

[
  {
    "capabilities": [
      {
        "name": "GetOrderById",
        "version": "v1"
      },
      {
        "name": "RecordOrderPaymentById",
        "version": "v1"
      }
    ],
    "url": "https://my-epos.com/orders",
    "auth": {
      "authType": "basic",
      "basic": {
        "username": "epos-1"
      }
    },
    "createdAt": "2024-03-30T12:00:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.