Pular para o conteúdo principal
POST
/
v1
/
providers
Criar um Provedor
curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "sendgrid-primary",
  "category": "Email",
  "type": "SendGrid",
  "clientId": "SG.your_api_key_here",
  "clientSecret": "your_secret",
  "host": "smtp.sendgrid.net",
  "port": 587,
  "disableSsl": false
}
'
{
  "id": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
  "name": "sendgrid-primary",
  "category": "Email",
  "type": "SendGrid",
  "host": "smtp.sendgrid.net",
  "port": 587,
  "disableSsl": false,
  "createdAt": "2025-04-08T08:01:30.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

​
Authorization
string
header
obrigatório

O token de autorização no formato 'Bearer '.

Corpo

application/json

Informações necessárias para criar um novo provedor de comunicação.

​
name
string
obrigatório

Um nome único para identificar o provedor.

​
category
enum<string>
obrigatório

A categoria do provedor.

Opções disponíveis:
Email,
SMS
​
type
enum<string>
obrigatório

O tipo de implementação do provedor.

Opções disponíveis:
SendGrid,
Twilio
​
clientId
string

ID do cliente ou chave de API para autenticação com o provedor.

​
clientSecret
string

Segredo do cliente ou segredo de API para autenticação com o provedor.

​
host
string

Endereço de host SMTP ou da API (provedores de e-mail).

​
port
integer

Porta SMTP (provedores de e-mail).

​
disableSsl
boolean
padrão:false

Defina como true para desabilitar SSL/TLS (não recomendado para produção).

Resposta

Indica que o provedor foi criado com sucesso e a operação foi concluída conforme esperado.

Informações sobre um provedor de comunicação.

​
id
string

Identificador único do provedor.

​
name
string

Nome do provedor.

​
category
enum<string>

Categoria do provedor.

Opções disponíveis:
Email,
SMS
​
type
enum<string>

Tipo de implementação do provedor.

Opções disponíveis:
SendGrid,
Twilio
​
subType
string

Subtipo do provedor, se aplicável.

​
method
string

Método de autenticação ou de entrega.

​
clientId
string

ID do cliente ou chave de API (o segredo nunca é retornado).

​
clientId2
string

ID de cliente secundário, se aplicável.

​
host
string

Endereço de host SMTP ou da API.

​
port
integer

Porta SMTP.

​
disableSsl
boolean

Indica se SSL/TLS está desabilitado.

​
title
string

Título/assunto padrão do e-mail ou SMS.

​
content
string

Modelo de conteúdo padrão da mensagem.

​
receiver
string

Endereço do destinatário padrão para testes.

​
regionId
string

ID da região da nuvem (específico do provedor).

​
signName
string

Nome de assinatura do SMS (específico do provedor).

​
templateCode
string

Código do modelo de SMS (específico do provedor).

​
appId
string

ID da aplicação (específico do provedor).

​
endpoint
string

URL do endpoint da API do provedor.

​
intranetEndpoint
string

Endpoint de intranet para acesso por rede privada.

​
domain
string

Domínio do provedor.

​
providerUrl
string

URL específica do provedor.

​
createdAt
string<date-time>

Registro de data e hora de quando o provedor foi criado.