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ão | Descrição |
|---|---|
request-center:read | Listar tipos e solicitações, inclusive as pendentes de notificação |
request-center:create | Criar novas solicitações |
request-center:update-status | Atualizar status ou dados de saída de solicitações e marcá-las como notificadas |
Status de uma Solicitação
| Status | Descrição | Terminal? |
|---|---|---|
nova | Solicitação recém-criada (status inicial) | Não |
pendente | Solicitação em processamento | Não |
concluida | Solicitação finalizada com sucesso | Sim |
erro | Solicitação finalizada com erro | Sim |
cancelada | Solicitação cancelada pelo usuário | Sim |
Os status terminais não podem ser alterados novamente.
Snapshot de serviços
Toda solicitação possui o campo services. Na criação, ele recebe uma cópia
ordenada dos serviços e itens habilitados para o tipo de solicitação. Essa cópia
é imutável: renomear, arquivar ou reconfigurar o catálogo não altera solicitações
existentes. Solicitações sem serviços habilitados retornam services: [].
Os códigos de serviço e item usam somente A-Z, 0-9 e _, têm no máximo 100
caracteres e são imutáveis depois da criação do registro no catálogo.
Filtro por serviço
As consultas GET /api/request-center/requests e
GET /api/request-center/requests/open aceitam o parâmetro opcional
serviceCode. Ele seleciona solicitações cujo tipo possui ao menos um item
vinculado ao serviço com o código exato informado, respeitando a organização e
os demais filtros. Um código sem vínculo correspondente retorna uma lista vazia.
O filtro considera os vínculos atuais do tipo. O campo services da resposta
continua sendo o snapshot registrado na criação da solicitação.
Exemplos:
/api/request-center/requests?serviceCode=CERTIDOES/api/request-center/requests/open?serviceCode=CERTIDOES
Filtro por ambiente
Todo tipo de solicitação possui o campo environment, com um dos valores
producao, homologacao ou desenvolvimento. Tipos criados antes da
existência do campo são considerados producao.
As consultas GET /api/request-center/requests e
GET /api/request-center/requests/open aceitam o parâmetro opcional
requestTypeEnvironment, que seleciona solicitações cujo tipo está no ambiente
informado. GET /api/request-center/types aceita o parâmetro environment para
filtrar os tipos. Valores fora da lista retornam 400.
Exemplos:
/api/request-center/requests?requestTypeEnvironment=homologacao/api/request-center/requests/open?requestTypeEnvironment=producao&serviceCode=CERTIDOES/api/request-center/types?environment=desenvolvimento
Notificação via automação
Por padrão, a Central de Processamento avisa o sistema externo enviando os dados da solicitação para a API dele quando o status muda (integrações Holmes e Fluig). Quando o sistema externo não tem uma API para receber esse envio, a notificação pode ser feita por uma automação do próprio cliente, que busca as solicitações finalizadas e informa ao sistema externo.
Para isso, ative Notificação via automação nas configurações do tipo de
solicitação, na aba Integrações da Central de Processamento. A partir do
momento da ativação, toda solicitação desse tipo que for finalizada com
status concluida ou erro fica pendente de notificação. Use o campo status
para diferenciar sucesso de erro. Solicitações finalizadas antes da ativação e
solicitações com status cancelada não entram na lista.
O fluxo da automação é:
GET /api/request-center/requests/pending-notificationlista as solicitações pendentes, da conclusão mais antiga para a mais recente, junto com o total pendente (pendingCount).- A automação notifica o sistema externo com os dados de cada solicitação.
PATCH /api/request-center/requests/{requestId}/notifiedmarca uma solicitação como notificada, ouPOST /api/request-center/requests/notifiedmarca várias de uma vez. A solicitação recebenotifiedAte um evento no histórico, e sai da lista de pendentes.- Repita até a lista voltar vazia. Não há
offset: as solicitações marcadas saem da lista, então a próxima leitura já traz as seguintes.
A mesma solicitação pode ser entregue mais de uma vez. Se a automação
notificar o sistema externo e falhar antes de marcar a solicitação, ou se duas
execuções rodarem ao mesmo tempo, a solicitação volta na próxima leitura. O
sistema externo deve usar o id da solicitação para ignorar repetições.
Marcar uma solicitação já notificada não gera erro: ela volta em
alreadyNotified e a data da primeira notificação é mantida. Se algum ID não
existir, pertencer a outra organização ou não estiver com status concluida ou
erro, a chamada falha e nenhuma solicitação do lote é marcada.
No detalhe da solicitação, o dashboard mostra quando ela foi notificada e permite desfazer a marcação, devolvendo a solicitação à lista de pendentes.
Exemplos:
/api/request-center/requests/pending-notification?requestTypeCode=certidoes&limit=20/api/request-center/requests/pending-notification?requestTypeEnvironment=producao
Endpoints
Ao criar uma solicitação, é obrigatório informar pelo menos um entre
requestTypeId e requestTypeCode. Ao cancelar, o campo cancellationReason
é obrigatório.
Endpoint /requests/holmes: use esta variante apenas quando a
solicitação for disparada pelo sistema Holmes. O Holmes não possui suporte
para controlar o corpo da requisição, então requestTypeId, requestTypeCode
e identification são recebidos como query params e todo o corpo enviado
é armazenado diretamente no campo data da solicitação. Para qualquer outro
integrador, utilize o endpoint padrão POST /api/request-center/requests.
Authorization
apiKey Chave de API para autenticação
In: header
Query Parameters
Filtra por nome (busca parcial, case-insensitive)
Filtra por código exato do tipo
Filtra pelo ambiente do tipo
"producao" | "homologacao" | "desenvolvimento"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",
"environment": "producao",
"externalNotificationEnabledAt": "2019-08-24T14:15:22Z",
"organizationId": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}Authorization
apiKey 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": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "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"
}Authorization
apiKey Chave de API para autenticação
In: header
Query Parameters
ID do tipo de solicitação (use este OU requestTypeCode)
uuidCódigo do tipo de solicitação (use este OU requestTypeId)
Identificador da solicitação (ex: número do pedido)
1 <= lengthRequest Body
application/json
Qualquer JSON enviado aqui será armazenado como o objeto data da solicitação.
TypeScript Definitions
Use the request body type in TypeScript.
Conteúdo livre — o payload inteiro é persistido em data
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/holmes?identification=string" \ -H "Content-Type: application/json" \ -d '{ "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": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "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"
}Authorization
apiKey Chave de API para autenticação
In: header
Query Parameters
Filtra por ID do tipo de solicitação
uuidFiltra por código do tipo de solicitação
Filtra pelo código exato do serviço vinculado atualmente ao tipo da solicitação. Combinado com os demais filtros; código sem vínculo retorna uma lista vazia.
Filtra pelo ambiente atual do tipo da solicitação. Valor inválido retorna 400.
"producao" | "homologacao" | "desenvolvimento"Filtra por status específico
"nova" | "pendente" | "concluida" | "erro" | "cancelada"Exclui status terminais (padrão: true)
"true""true" | "false"Data de criação mínima (ISO 8601)
date-timeData de criação máxima (ISO 8601)
date-timeFiltro JSONB nos dados da solicitação (JSON stringificado)
Máximo de resultados (1–200)
501 <= value <= 200Offset para paginação
00 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://api.runner.dclick.com.br/api/request-center/requests?serviceCode=CERTIDOES&dataFilter=%7B%22fornecedor%22%3A%22Empresa+XYZ%22%7D"[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
"identification": "string",
"data": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "string",
"requestType": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"code": "string",
"description": "string",
"environment": "producao",
"externalNotificationEnabledAt": "2019-08-24T14:15:22Z",
"organizationId": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"events": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"message": "string",
"status": "sucesso",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}
]{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}Authorization
apiKey Chave de API para autenticação
In: header
Query Parameters
Filtra por ID do tipo de solicitação
uuidFiltra por código do tipo de solicitação
Filtra pelo código exato do serviço vinculado atualmente ao tipo da solicitação. Combinado com os demais filtros; código sem vínculo retorna uma lista vazia.
Filtra pelo ambiente atual do tipo da solicitação. Valor inválido retorna 400.
"producao" | "homologacao" | "desenvolvimento"Data de criação mínima (ISO 8601)
date-timeData de criação máxima (ISO 8601)
date-timeFiltro JSONB nos dados da solicitação (JSON stringificado)
Máximo de resultados (1–200)
501 <= value <= 200Offset para paginação
00 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://api.runner.dclick.com.br/api/request-center/requests/open?serviceCode=CERTIDOES"[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
"identification": "string",
"data": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "string",
"requestType": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"code": "string",
"description": "string",
"environment": "producao",
"externalNotificationEnabledAt": "2019-08-24T14:15:22Z",
"organizationId": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"events": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"message": "string",
"status": "sucesso",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}
]{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}Authorization
apiKey Chave de API para autenticação
In: header
Path Parameters
ID da solicitação
uuidRequest 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/output-data" \ -H "Content-Type: application/json" \ -d '{ "outputData": { "numeroProtocolo": "PRT-2026-001", "resultado": "aprovado" }, "status": "concluida", "event": { "message": "Pedido processado com sucesso", "status": "sucesso" } }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
"identification": "string",
"data": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "string"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "Request not found",
"code": "REQUEST_NOT_FOUND"
}Authorization
apiKey Chave de API para autenticação
In: header
Path Parameters
ID da solicitação
uuidRequest 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": "sucesso" } }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
"identification": "string",
"data": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "string"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "Request not found",
"code": "REQUEST_NOT_FOUND"
}Authorization
apiKey Chave de API para autenticação
In: header
Query Parameters
Filtra por ID do tipo de solicitação
uuidFiltra por código do tipo de solicitação
Filtra pelo ambiente atual do tipo da solicitação
"producao" | "homologacao" | "desenvolvimento"Máximo de resultados (1–200)
501 <= value <= 200Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.runner.dclick.com.br/api/request-center/requests/pending-notification"{
"requests": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestTypeId": "3f310912-bb72-4e0c-bd7a-724d6a05f329",
"identification": "string",
"data": {},
"outputData": {},
"services": [
{
"id": "11111111-1111-4111-8111-111111111111",
"code": "CERTIDOES",
"name": "Certidões",
"items": [
{
"id": "22222222-2222-4222-8222-222222222222",
"code": "CERTIDAO_FEDERAL",
"name": "Certidão Federal"
}
]
}
],
"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",
"notifiedAt": "2019-08-24T14:15:22Z",
"notifiedBy": "string",
"requestType": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"code": "string",
"description": "string",
"environment": "producao",
"externalNotificationEnabledAt": "2019-08-24T14:15:22Z",
"organizationId": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
}
],
"pendingCount": 0
}{
"error": "string",
"code": "string",
"details": [
{}
]
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}Authorization
apiKey Chave de API para autenticação
In: header
Path Parameters
ID da solicitação
uuidResponse 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/notified"{
"notified": [
"11111111-1111-4111-8111-111111111111"
],
"alreadyNotified": []
}{
"error": "Only completed or failed requests can be marked as notified: 11111111-1111-4111-8111-111111111111 (pendente)",
"code": "REQUEST_NOT_COMPLETED"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "Requests not found: 11111111-1111-4111-8111-111111111111",
"code": "REQUEST_NOT_FOUND"
}Authorization
apiKey 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/notified" \ -H "Content-Type: application/json" \ -d '{ "requestIds": [ "11111111-1111-4111-8111-111111111111", "22222222-2222-4222-8222-222222222222" ] }'{
"notified": [
"11111111-1111-4111-8111-111111111111"
],
"alreadyNotified": []
}{
"error": "Only completed or failed requests can be marked as notified: 11111111-1111-4111-8111-111111111111 (pendente)",
"code": "REQUEST_NOT_COMPLETED"
}{
"error": "string",
"code": "string"
}{
"error": "string",
"code": "string"
}{
"error": "Requests not found: 11111111-1111-4111-8111-111111111111",
"code": "REQUEST_NOT_FOUND"
}