IM
ID
Beranda dokumentasi
Menu
Panduan

Kredensial dan Konektivitas Penyedia

daftarkan kredensial IMAP/SMTP, validasi konektivitas, dan pertahankan siklus hidup kredensial.

inbox-manager client-flow

Kredensial dan Konektivitas Penyedia

Tujuan: mendaftarkan kredensial IMAP/SMTP, memvalidasi konektivitas, dan memelihara siklus hidup kredensial.

Aliran UI

  1. Pengguna memasukkan IMAP dan SMTP mode host/port/keamanan dan nilai rahasia.
  2. UI membuat kredensial dengan POST /api/accounts/:account_id/provider-credentials.
  3. UI segera memvalidasi menggunakan POST /api/provider-credentials/:provider_credential_id/test.
  4. UI mencantumkan kredensial dan status validasi.
  5. UI mendukung rotasi (/rotate) dan penghapusan untuk kebersihan kredensial.

Alur Perpustakaan Klien

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);

Alur 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":"***"}}'

Skrip Validasi

  • scripts/provider_credentials_flow.sh