Oblic

ಉಪಖಾತೆಗಳು

ತನ್ನ ಗ್ರಾಹಕರ ಪರವಾಗಿ ಸಂದೇಶ ಕಳುಹಿಸುವ ವೇದಿಕೆ ಪ್ರತಿಯೊಬ್ಬರಿಗೂ ಉಪಖಾತೆಯನ್ನು ಒದಗಿಸುತ್ತದೆ: ಸ್ವಂತ ಕಳುಹಿಸುವವರು, ಟೆಂಪ್ಲೇಟ್‌ಗಳು, ಸಂದೇಶಗಳು ಮತ್ತು ವರದಿಗಳಿರುವ ಪ್ರತ್ಯೇಕ Oblic ಸಂಸ್ಥೆ. ಅದನ್ನು ಸೂಚಿಸುವ ಮೂಲಕ ನಿಮ್ಮ ಕೀ ಅದರ ಪರವಾಗಿ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ. ಉಪಖಾತೆಗಳನ್ನು ನಿರ್ವಹಿಸಲು accounts:manage ಹೊಂದಿರುವ Owner ಅಥವಾ Admin ಕೀ ಬೇಕು.


POST/external/v1/accounts

ಉಪಖಾತೆಯನ್ನು ರಚಿಸುವುದು

  • ಹೆಸರು
    name
    ಟೈಪ್ ಮಾಡಿ
    string
    ವಿವರಣೆ

    ಅಗತ್ಯ: ಗ್ರಾಹಕರ ಹೆಸರು, ಗರಿಷ್ಠ 511 ಅಕ್ಷರಗಳು.

  • ಹೆಸರು
    externalId
    ಟೈಪ್ ಮಾಡಿ
    string
    ವಿವರಣೆ

    ಅಗತ್ಯ: ನಿಮ್ಮ ವ್ಯವಸ್ಥೆಯಲ್ಲಿನ ಗ್ರಾಹಕರ ಗುರುತು, ಗರಿಷ್ಠ 100 ASCII ಅಕ್ಷರಗಳು, ಅಂಕೆಗಳು ಮತ್ತು _, ., :, - ಚಿಹ್ನೆಗಳು. ನಂತರ ಉಪಖಾತೆಯನ್ನು ಸೂಚಿಸಲು ಇದನ್ನು ಬಳಸಿ.

  • ಹೆಸರು
    issueKey
    ಟೈಪ್ ಮಾಡಿ
    boolean
    ವಿವರಣೆ

    ಉಪಖಾತೆಗೆ ಸ್ವಂತ API ಕೀ ನೀಡಬೇಕೇ ಎಂಬುದು; ಪೂರ್ವನಿಯೋಜಿತ ಮೌಲ್ಯ true.

ಉಪಖಾತೆಯನ್ನು ರಚಿಸುವುದು

curl -X POST https://api.oblic.app/external/v1/accounts \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Asha Textiles", "externalId": "tenant-4821" }'

ಪ್ರತಿಕ್ರಿಯೆ

{
  "status": "success",
  "data": {
    "id": "ORG000R7ZM4Q2VXH00",
    "name": "Asha Textiles",
    "externalId": "tenant-4821",
    "active": true,
    "createdAt": "2026-10-24T09:30:00Z",
    "apiKey": "obl_live_…"
  },
  "errors": null
}
  • apiKey ಈ ಪ್ರತಿಕ್ರಿಯೆಯಲ್ಲಿ ಮಾತ್ರ ಕಾಣುತ್ತದೆ: ಆಗಲೇ ಉಳಿಸಿಕೊಳ್ಳಿ ಅಥವಾ ಮತ್ತೊಂದು ಕೀಗಾಗಿ ಉಪಖಾತೆಯನ್ನು ಮತ್ತೆ ರಚಿಸಿ. ಇದು ಹಳೆಯ ಪೂರ್ವನಿಯೋಜಿತ ಅನುಮತಿಗಳಿರುವ User ಕೀ; ಅವುಗಳಲ್ಲಿ events:write ಇಲ್ಲ. ಕಳುಹಿಸಲು, ಓದಲು ಹಾಗೂ ಗುರುತುಗಳು ಮತ್ತು ಸಂಪರ್ಕ ಪಟ್ಟಿಗಳನ್ನು ನಿರ್ವಹಿಸಲು ಸಾಧ್ಯ, ಆದರೆ Owner ಅಥವಾ Admin ಕೀ ಅಗತ್ಯವಿರುವ ಮಾರ್ಗಗಳನ್ನು ಕರೆಯಲು ಸಾಧ್ಯವಿಲ್ಲ.
  • ಅದೇ externalId ಅನ್ನು ಮತ್ತೆ ನೀಡಿದರೆ ಅದೇ ಉಪಖಾತೆ ಮರಳುತ್ತದೆ; ನಿಷ್ಕ್ರಿಯವಾಗಿದ್ದರೆ ಪುನಃ ಸಕ್ರಿಯವಾಗುತ್ತದೆ ಮತ್ತು ಹೆಸರು ಬದಲಾಗುವುದಿಲ್ಲ. issueKey ಮೌಲ್ಯ false ಆಗಿರದಿದ್ದರೆ ಪ್ರತಿ ಕರೆಯೂ ಮತ್ತೊಂದು ಕೀ ನೀಡುತ್ತದೆ. ನಿಷ್ಕ್ರಿಯಗೊಳಿಸುವಾಗ ರದ್ದುಪಡಿಸಿದ ಕೀಗಳನ್ನು ಹೊರತುಪಡಿಸಿ ಹಳೆಯ ಕೀಗಳು ಕೆಲಸ ಮಾಡುತ್ತವೆ.
  • ಉಪಖಾತೆಗೆ ತನ್ನದೇ ಉಪಖಾತೆಗಳಿರುವುದಿಲ್ಲ: ಉಪಖಾತೆಯ ಪರವಾಗಿ ಕಾರ್ಯನಿರ್ವಹಿಸುವಾಗ ಮತ್ತೊಂದನ್ನು ರಚಿಸಿದರೆ 403 SUB_ACCOUNT_NOT_ALLOWED ಮರಳುತ್ತದೆ.

GET/external/v1/accounts

ಉಪಖಾತೆಗಳ ಪಟ್ಟಿಯನ್ನು ನೋಡುವುದು

ರಚಿಸಿದ ಕ್ರಮದಲ್ಲಿ ಎಲ್ಲ ಉಪಖಾತೆಗಳೂ ಸಿಗುತ್ತವೆ; active ಮೌಲ್ಯ false ಇರುವ ನಿಷ್ಕ್ರಿಯ ಖಾತೆಗಳೂ ಸೇರಿವೆ. ಪಟ್ಟಿಯಲ್ಲಿ ಕೀಗಳು ಎಂದಿಗೂ ಇರುವುದಿಲ್ಲ.


DELETE/external/v1/accounts/{accountId}

ಉಪಖಾತೆಯನ್ನು ನಿಷ್ಕ್ರಿಯಗೊಳಿಸುವುದು

Oblic ನ id ಬಳಸಿ ಉಪಖಾತೆಯನ್ನು ನಿಷ್ಕ್ರಿಯಗೊಳಿಸುತ್ತದೆ, ನಿಮ್ಮ externalId ಅಲ್ಲ; ಅದರ ಎಲ್ಲ ಕೀಗಳನ್ನು ತಕ್ಷಣ ರದ್ದುಪಡಿಸುತ್ತದೆ. ಅದೇ externalId ಮೂಲಕ ಮತ್ತೆ ರಚಿಸಿದರೆ ಸಕ್ರಿಯವಾಗುತ್ತದೆ. ಸಂಸ್ಥೆಗೆ ಸೇರದ ಉಪಖಾತೆಗೆ 404 ACCOUNT_NOT_FOUND ಮರಳುತ್ತದೆ.


ಉಪಖಾತೆಯ ಪರವಾಗಿ ಕಾರ್ಯನಿರ್ವಹಿಸುವುದು

X-Oblic-On-Behalf-Of ನಲ್ಲಿ ಉಪಖಾತೆಯ externalId ಕಳುಹಿಸಿ. ವಿನಂತಿ ಅದರ ಸ್ವಂತ ಕೀ ಬಳಸಿದಂತೆ ಅದರ ಪರವಾಗಿ ನಡೆಯುತ್ತದೆ. ನಿಮ್ಮ ಒಂದೇ ಕೀ ಎಲ್ಲ ಗ್ರಾಹಕರಿಗೂ ಸಾಕು; ಪ್ರತಿ ಗ್ರಾಹಕರಿಗೆ ಪ್ರತ್ಯೇಕ ಕೀ ಉಳಿಸಬೇಕಿಲ್ಲ.

ಗ್ರಾಹಕರ ಖಾತೆಯಿಂದ ಕಳುಹಿಸುವುದು

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Oblic-On-Behalf-Of: tenant-4821' \
  -H 'Content-Type: application/json' \
  -d '{ "from": "hello@ashatextiles.example", "to": ["asha@example.org"], "subject": "Welcome", "html": "<p>Welcome!</p>" }'
  • ಉಪಖಾತೆಯ ಸ್ವಂತದ್ದು: ಇಮೇಲ್ ಅದರ ಸ್ವಂತ ಗುರುತುಗಳಿಂದ ಮಾತ್ರ ಹೋಗುತ್ತದೆ; ಸಂದೇಶಗಳು, ವರದಿಗಳು, ಟೆಂಪ್ಲೇಟ್‌ಗಳು, ವೆಬ್‌ಹುಕ್‌ಗಳು ಮತ್ತು Idempotency-Key ಮೌಲ್ಯಗಳೂ ಪ್ರತ್ಯೇಕವಾಗಿರುತ್ತವೆ.
  • ನಿಮ್ಮ ಸಂಸ್ಥೆಯದ್ದು: ನಿಮ್ಮ ಸಂಸ್ಥೆಯ ವಾಲೆಟ್ ಅದರ ಸಂದೇಶಗಳಿಗೆ ಪಾವತಿಸುತ್ತದೆ ಮತ್ತು ಅದರ ಪರವಾಗಿ ಮಾಡುವ ವಿನಂತಿಗಳಿಗೆ ನಿಮ್ಮ ಅನುಮತಿಸಲಾದ IP ಪಟ್ಟಿ ಅನ್ವಯಿಸುತ್ತದೆ.
  • ನಿಮ್ಮ ಕೀಯ ಪಾತ್ರವೇ ಅನ್ವಯಿಸುತ್ತದೆ, ಆದ್ದರಿಂದ ಗ್ರಾಹಕರ ಟೆಂಪ್ಲೇಟ್‌ಗಳು, ವೆಬ್‌ಹುಕ್‌ಗಳು ಅಥವಾ WhatsApp ಸಂಖ್ಯೆಯನ್ನು ನಿಮ್ಮ Owner ಅಥವಾ Admin ಕೀ ಮತ್ತು ಹೆಡರ್ ಮೂಲಕ ನಿರ್ವಹಿಸಿ.
  • ಸಕ್ರಿಯ ಉಪಖಾತೆ ಇಲ್ಲದ externalId ಗೆ 404 ACCOUNT_NOT_FOUND ಮರಳುತ್ತದೆ.
  • ಉಪಖಾತೆಯ ವೆಬ್‌ಹುಕ್ ಘಟನೆಗಳು ಅದರ ಸ್ವಂತ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳಿದ್ದರೆ ಅಲ್ಲಿಗೆ, ಇಲ್ಲದಿದ್ದರೆ ನಿಮ್ಮ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳಿಗೆ ಹೋಗುತ್ತವೆ. ಅದರ externalId ಪ್ರತಿ ಘಟನೆಯ account ನಲ್ಲಿ ಇರುತ್ತದೆ. ವೆಬ್‌ಹುಕ್‌ಗಳು ನೋಡಿ.
  • ಉಪಖಾತೆ ಕಳುಹಿಸುವ SMS ಟೆಂಪ್ಲೇಟ್‌ಗಳು ನೀವು ಅದರೊಂದಿಗೆ ಹಂಚಿಕೊಂಡ ಟೆಂಪ್ಲೇಟ್‌ಗಳೇ. ಟೆಂಪ್ಲೇಟ್‌ಗಳು ನೋಡಿ.
ಈ ಪುಟವು ಸಹಾಯಕವಾಗಿದೆಯೇ?