IM
ES
Inicio de documentación
Menú
Guías

Credenciales de proveedor y conectividad

registrar IMAP/SMTP credenciales, validar la conectividad y mantener el ciclo de vida de las credenciales.

inbox-manager client-flow

Credenciales de proveedor y conectividad

Propósito: registrar IMAP/SMTP credenciales, validar la conectividad y mantener el ciclo de vida de las credenciales.

Flujo de interfaz de usuario

  1. El usuario ingresa IMAP y SMTP host/puerto/modo de seguridad y valores secretos.
  2. La interfaz de usuario crea una credencial con POST /api/accounts/:account_id/provider-credentials.
  3. La interfaz de usuario se valida inmediatamente usando POST /api/provider-credentials/:provider_credential_id/test.
  4. La interfaz de usuario enumera las credenciales y el estado de validación.
  5. La interfaz de usuario admite rotar (/rotate) y eliminar para higiene de credenciales.

Flujo de la biblioteca del cliente

const imapCredential = await api.credentials.create(accountId, {
  provider_kind: "imap",
  label: "Work IMAP",
  host: "mail.example.com",
  port: 993,
  security_mode: "ssl_tls",
  auth_kind: "password",
  secret: { username, password },
});
await api.credentials.test(imapCredential.data.id);

Flujo HTTP/curl

API_BASE_URL="https://api.inbox-manager.com"

curl -sS -X POST "${API_BASE_URL}/api/accounts/${ACCOUNT_ID}/provider-credentials" \
  -H "authorization: Bearer ${BEARER_TOKEN}" \
  -H "content-type: application/json" \
  --data '{
    "provider_kind":"imap",
    "label":"Work IMAP",
    "host":"mail.example.com",
    "port":993,
    "security_mode":"ssl_tls",
    "auth_kind":"password",
    "secret":{"username":"user@example.com","password":"***"}
  }'

curl -sS -X POST "${API_BASE_URL}/api/provider-credentials/${PROVIDER_CREDENTIAL_ID}/test" \
  -H "authorization: Bearer ${BEARER_TOKEN}"

curl -sS -X POST "${API_BASE_URL}/api/provider-credentials/${PROVIDER_CREDENTIAL_ID}/rotate" \
  -H "authorization: Bearer ${BEARER_TOKEN}" \
  -H "content-type: application/json" \
  --data '{"secret":{"username":"user@example.com","password":"***"}}'

Script de validación

  • scripts/provider_credentials_flow.sh