| Parâmetro | Descrição | Tipo | Suporta DB | Padrão |
|---|---|---|---|---|
| Methods | Define os métodos aceitos pelo pipeline. | String | ❌ | POST, PUT, GET, PATCH and DELETE |
| Response Headers | Cabeçalhos retornados pelo endpoint quando o processamento do pipeline é concluído. Evite caracteres especiais nas chaves, pois podem causar falhas em proxies e gateways. | Pares chave-valor | ✅ | N/A |
| Add Cross-Origin Resource Sharing (CORS) | Quando habilitado, permite adicionar cabeçalhos CORS que serão retornados pelo endpoint após o processamento do pipeline. Use vírgula ( | Booleano | ❌ | False |
| CORS Headers | Define CORS especificamente para o pipeline e suas restrições. Para configurá-lo globalmente (em vez de individualmente por pipeline), consulte a política CORS HTTP Header. | Pares chave-valor | ❌ | N/A |
| Form Data Uploads | Habilita ou desabilita o recebimento de uploads via form data (multipart/form-data). | Booleano | ❌ | True |
| Body Uploads | Habilita ou desabilita o recebimento de uploads via body. | Booleano | ❌ | True |
| Body Upload Content Types | Define os tipos de conteúdo permitidos pelo pipeline para uploads via body. | String | ❌ | application/pdf, application/jpeg |
| Response Content Types | Define os tipos de conteúdo permitidos na resposta do pipeline. Exemplo: determina o formato da resposta. | String | ✅ | text/xml, application/xml |
| Maximum Timeout | Tempo máximo (em milissegundos) que o pipeline pode levar para processar informações antes de retornar uma resposta. Limite: Se o processamento ultrapassar esse limite, a requisição é encerrada e retorna um código | Integer | ❌ | 30000 |
| Maximum Request Size | Define o tamanho máximo do arquivo na requisição de upload (em MB). Máximo: 100 MB. | Integer | ❌ | 100 |
| External API | Quando habilitado, publica a API em um gateway externo. | Booleano | ❌ | True |
| Internal API | Quando habilitado, publica a API em um gateway interno. | Booleano | ❌ | False |
| mTLS enabled API | Quando habilitado, publica a API em um gateway dedicado com mTLS, com um host de acesso diferente. O pipeline pode ter as opções External API e Internal API habilitadas, mas recomenda-se mantê-las desativadas. Este parâmetro não oferece suporte a API Key, JWT ou Basic Auth. Para habilitá-los no seu realm, entre em contato com o Suporte. | Booleano | ❌ | False |
| API Key | Quando habilitado, o endpoint só pode ser acessado se uma API Key tiver sido previamente configurada na Plataforma Digibee. | Booleano | ❌ | False |
| Token JWT | Quando habilitado, solicita o token para consumo da API. | Booleano | ❌ | False |
| Basic Auth | Quando habilitado, o endpoint só pode ser consumido se uma configuração de Basic Auth estiver presente na requisição. Essa configuração pode ser registrada previamente pela página Consumers na Plataforma da Digibee. | Booleano | ❌ | False |
| Additional API Routes | Quando habilitado, permite adicionar novas rotas. | Booleano | ❌ | False |
| Remove Digibee Prefix from Route | Remove o prefixo padrão da rota da Digibee Disponível apenas quando os parâmetros External API e Internal API estão desativados e os parâmetros mTLS enabled API e Additional API Routes estão habilitados. | Booleano | ❌ | False |
| Routes | Define rotas personalizadas. | String | ❌ | N/A |
| Rate Limit | Quando habilitado, aplica limitação de taxa ao gateway da API. Disponível se API Key ou Basic Auth estiverem habilitados. | Booleano | ❌ | False |
| Limit by | Define a entidade à qual os limites serão aplicados. | String | ❌ | API |
| Aggregate by | Define a entidade usada para agregação dos limites. Opções: Consumers e Credential (API Key, Basic Auth). | String | ❌ | Consumer |
| Options | Define o limite de requisições permitidas dentro de um intervalo de tempo. | Opções de limite e intervalo | ❌ | N/A |
| Interval | Define o intervalo de tempo para o limite de requisições. Opções: second, minute, hour, day e month. | String | ❌ | second |
| Limit | Define o número máximo de requisições que os usuários podem fazer dentro do intervalo especificado. | Integer | ❌ | N/A |
| Allow Redelivery Of Messages | Quando habilitado, permite a reenviar mensagens em caso de falha do Pipeline Engine. | Booleano | ❌ | False |