Receba novidades do Hedhog no seu e-mail
Novos lançamentos, receitas e breaking changes — sem spam.
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
| Field | Type | Required | Notes |
|---|---|---|---|
| slug | string | yes | Max 255 chars |
| name | string | yes | Max 127 chars |
| type_id | number | yes | Min 1 |
| provider_id | number | yes | Min 1 |
| config | object | no | — |
| is_active | boolean | no | — |
Testa a configuração de um integration profile sem salvar.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| slug | string | yes | Max 255 chars |
| name | string | yes | Max 127 chars |
| type_id | number | yes | — |
| provider_id | number | yes | — |
| config | object | no | — |
Atualiza um integration profile.
- Params
- id (int)
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| slug | string | no | Max 255 chars |
| name | string | no | Max 127 chars |
| type_id | number | no | — |
| provider_id | number | no | — |
| config | object | no | — |
| is_active | boolean | no | — |
Exclui um ou mais integration profiles.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| ids | number[] | yes | IDs to delete |
Valida um arquivo de importação de integration profile antes de aplicá-lo.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| file | File | yes | JSON export file, multipart/form-data |
Confirma e aplica uma importação de integration profile previamente validada.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
| profiles | { slug, name, type_slug, provider_slug, config?, is_active? }[] | yes | ArrayNotEmpty |
| conflict_resolutions | { slug, action: "ignore" | "replace" | "rename_auto" }[] | no | — |
Ferramentas MCP
Nenhuma ferramenta MCP mapeada para este submódulo.