Logotipo Hedhog

Receba novidades do Hedhog no seu e-mail

Novos lançamentos, receitas e breaking changes — sem spam.

Voltar para os módulos CoreIntegrado no CoreModule

Submódulo Core

integration-profile

Configura integration profiles, provedores e operações de importação/exportação.

Caminho de origem: libraries/core/src/integration-profile

Arquivo do módulo: integration-profile.module.ts

Introdução

Esta página documenta o submódulo integration-profile como parte do pacote Core. Use-a como referência técnica rápida para escopo de implementação, APIs expostas e pontos de integração MCP.

Endpoints HTTP

11 endpoints

Lista todos os tipos de integração disponíveis.

Lista os provedores disponíveis, opcionalmente filtrados por tipo de integração.

Query
typeId? (int), typeSlug? (string)

Lista os integration profiles com filtros opcionais.

Query
page, pageSize, typeId?, typeSlug?, providerSlug?

Exporta os integration profiles como JSON, opcionalmente incluindo os secrets.

Query
ids: number[], include_secrets? (bool)

Obtém um integration profile pelo ID.

Params
id (int)

Cria um novo integration profile.

Body

FieldTypeRequiredNotes
slugstringyesMax 255 chars
namestringyesMax 127 chars
type_idnumberyesMin 1
provider_idnumberyesMin 1
configobjectno
is_activebooleanno

Testa a configuração de um integration profile sem salvar.

Body

FieldTypeRequiredNotes
slugstringyesMax 255 chars
namestringyesMax 127 chars
type_idnumberyes
provider_idnumberyes
configobjectno

Atualiza um integration profile.

Params
id (int)

Body

FieldTypeRequiredNotes
slugstringnoMax 255 chars
namestringnoMax 127 chars
type_idnumberno
provider_idnumberno
configobjectno
is_activebooleanno

Exclui um ou mais integration profiles.

Body

FieldTypeRequiredNotes
idsnumber[]yesIDs to delete

Valida um arquivo de importação de integration profile antes de aplicá-lo.

Body

FieldTypeRequiredNotes
fileFileyesJSON export file, multipart/form-data

Confirma e aplica uma importação de integration profile previamente validada.

Body

FieldTypeRequiredNotes
profiles{ slug, name, type_slug, provider_slug, config?, is_active? }[]yesArrayNotEmpty
conflict_resolutions{ slug, action: "ignore" | "replace" | "rename_auto" }[]no

Ferramentas MCP

Nenhuma ferramenta MCP mapeada para este submódulo.