post https://gateway.besinky.com/api/sandbox/endpoint
Utilizado para criar um novo endpoint customizado
🛠️ Introdução
A API de Criação de novo endpoint customizado permite ao usuário a possibilidade de criar integrações próprias para utilização no Studio.
O usuário poderá determinar seus próprios campos, headers, parâmetros e template de saída para utilização em nós no Studio.
❗ Estrutura de exceptions
exceptions| Campo | Tipo | Descrição |
|---|---|---|
message | string | Descrição do erro ocorrido. Exemplos: "O nome é obrigatório.", "A descrição é obrigatória." |
📦 Corpo da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
_id | string | Identificador único do registro |
companyId | string | Identificador da empresa |
name | string | Nome |
description | string | Descrição |
active | boolean | Indica se está ativo |
url | string | URL de integração |
integrationSlug | array | Lista de slugs de integração |
method | string | Método HTTP utilizado (ex: POST) |
outputVariables | string | Variáveis de saída |
studioAuth | string | Tipo de autenticação do estúdio (ex: bearer) |
body | string | Corpo da requisição |
bodyMode | string | Modo do corpo da requisição (ex: none) |
rawBodyLanguage | string | Linguagem do corpo bruto (ex: json) |
urlEncodedItems | array | Lista de parâmetros x-www-form-urlencoded |
formDataItems | array | Lista de itens form-data |
pathParams | array | Lista de parâmetros de caminho |
hasAPIPaginationParameters | boolean | Indica se a API possui parâmetros de paginação |
paginationNextPageParameterName | string | Nome do parâmetro da próxima página de paginação |
paginationPreviousPageParameterName | string | Nome do parâmetro da página anterior de paginação |
preLoadAllPages | boolean | Indica se todas as páginas devem ser pré-carregadas |
pushPreloadedPagesIntoParameter | string | Parâmetro no qual páginas pré-carregadas são inseridas |
isAuthenticationEndpoint | boolean | Indica se é um endpoint de autenticação |
documentType | string | Tipo de documento (ex: AMBOS) |
isSoap | boolean | Indica se a integração é SOAP |
createdAt | date | Data de criação do registro |
updatedAt | date | Data de atualização do registro |
__v | number | Versão do documento |