Runner

Central de Processamento

API para gerenciar solicitações e tipos de solicitação

A Central de Processamento é um sistema de gerenciamento de solicitações baseado em tipos. Ele permite que sistemas externos criem, listem e atualizem o status de solicitações processadas por automações RPA.

Permissões

PermissãoDescrição
request-center:readListar tipos e solicitações
request-center:createCriar novas solicitações
request-center:update-statusAtualizar status de solicitações

Status de uma Solicitação

StatusDescriçãoTerminal?
novaSolicitação recém-criada (status inicial)Não
pendenteSolicitação em processamentoNão
concluidaSolicitação finalizada com sucessoSim
erroSolicitação finalizada com erroSim
canceladaSolicitação cancelada pelo usuárioSim

Os status terminais não podem ser alterados novamente.

Endpoints

Ao criar uma solicitação, é obrigatório informar pelo menos um entre requestTypeId e requestTypeCode. Ao cancelar, o campo cancellationReason é obrigatório.

GET
/api/request-center/types

Authorization

apiKey
x-api-key<token>

Chave de API para autenticação

In: header

Query Parameters

label?string

Filtra por nome (busca parcial, case-insensitive)

code?string

Filtra por código exato do tipo

Response Body

application/json

application/json

application/json

curl -X GET "https://api.runner.dclick.com.br/api/request-center/types"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "label": "string",
    "code": "string",
    "description": "string",
    "organizationId": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
]
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
POST
/api/request-center/requests

Authorization

apiKey
x-api-key<token>

Chave de API para autenticação

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.runner.dclick.com.br/api/request-center/requests" \  -H "Content-Type: application/json" \  -d '{    "requestTypeCode": "pedido-compra",    "identification": "PC-2026-001",    "data": {      "valor": 1500,      "fornecedor": "Empresa XYZ",      "itens": [        "Item A",        "Item B"      ]    }  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
  "identification": "string",
  "data": {},
  "status": "nova",
  "organizationId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "cancelledBy": "string",
  "cancellationReason": "string"
}
{
  "error": "string",
  "code": "string",
  "details": [
    {}
  ]
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "Request type not found in this organization",
  "code": "REQUEST_TYPE_NOT_FOUND"
}
GET
/api/request-center/requests

Authorization

apiKey
x-api-key<token>

Chave de API para autenticação

In: header

Query Parameters

requestTypeId?string

Filtra por ID do tipo de solicitação

Formatuuid
requestTypeCode?string

Filtra por código do tipo de solicitação

status?string

Filtra por status específico

Value in"nova" | "pendente" | "concluida" | "erro" | "cancelada"
excludeTerminal?string

Exclui status terminais (padrão: true)

Default"true"
Value in"true" | "false"
startDate?string

Data de criação mínima (ISO 8601)

Formatdate-time
endDate?string

Data de criação máxima (ISO 8601)

Formatdate-time
dataFilter?string

Filtro JSONB nos dados da solicitação (JSON stringificado)

limit?integer

Máximo de resultados (1–200)

Default50
Range1 <= value <= 200
offset?integer

Offset para paginação

Default0
Range0 <= value

Response Body

application/json

application/json

application/json

curl -X GET "https://api.runner.dclick.com.br/api/request-center/requests?dataFilter=%7B%22fornecedor%22%3A%22Empresa+XYZ%22%7D"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
    "identification": "string",
    "data": {},
    "status": "nova",
    "organizationId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "cancelledBy": "string",
    "cancellationReason": "string",
    "requestType": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "code": "string",
      "description": "string",
      "organizationId": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    },
    "events": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
        "message": "string",
        "status": "string",
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  }
]
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
GET
/api/request-center/requests/open

Authorization

apiKey
x-api-key<token>

Chave de API para autenticação

In: header

Query Parameters

requestTypeId?string

Filtra por ID do tipo de solicitação

Formatuuid
requestTypeCode?string

Filtra por código do tipo de solicitação

startDate?string

Data de criação mínima (ISO 8601)

Formatdate-time
endDate?string

Data de criação máxima (ISO 8601)

Formatdate-time
dataFilter?string

Filtro JSONB nos dados da solicitação (JSON stringificado)

limit?integer

Máximo de resultados (1–200)

Default50
Range1 <= value <= 200
offset?integer

Offset para paginação

Default0
Range0 <= value

Response Body

application/json

application/json

application/json

curl -X GET "https://api.runner.dclick.com.br/api/request-center/requests/open"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
    "identification": "string",
    "data": {},
    "status": "nova",
    "organizationId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "cancelledBy": "string",
    "cancellationReason": "string",
    "requestType": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "code": "string",
      "description": "string",
      "organizationId": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    },
    "events": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
        "message": "string",
        "status": "string",
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  }
]
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
PATCH
/api/request-center/requests/{requestId}/status

Authorization

apiKey
x-api-key<token>

Chave de API para autenticação

In: header

Path Parameters

requestId*string

ID da solicitação

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.runner.dclick.com.br/api/request-center/requests/497f6eca-6276-4993-bfeb-53cbbbba6f08/status" \  -H "Content-Type: application/json" \  -d '{    "status": "concluida",    "event": {      "message": "Pedido processado com sucesso",      "status": "finalizado"    }  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
  "identification": "string",
  "data": {},
  "status": "nova",
  "organizationId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "cancelledBy": "string",
  "cancellationReason": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "Request not found",
  "code": "REQUEST_NOT_FOUND"
}

Cofre

API para recuperar segredos criptografados do cofre