Oblic

ದೃಢೀಕರಣ

Oblic API ಯ ಪ್ರತಿ ಕರೆಯಲ್ಲಿ Oblic ಸೆಟ್ಟಿಂಗ್‌ಗಳಲ್ಲಿ ಪಾತ್ರ ಮತ್ತು ಅಗತ್ಯ ಅನುಮತಿ ವ್ಯಾಪ್ತಿಗಳೊಂದಿಗೆ ರಚಿಸಿದ API ಕೀಲಿಯನ್ನು ಕಳುಹಿಸಬೇಕು. ಕೀಲಿಯನ್ನು ನಿಮ್ಮ ಸಂಸ್ಥೆಯ IP ಅನುಮತಿ ಪಟ್ಟಿಯ ವಿಳಾಸಗಳಿಗೆ ಸೀಮಿತಗೊಳಿಸಬಹುದು. API v2 ಬದಲಾಗಿ OAuth ಪ್ರವೇಶ ಟೋಕನ್‌ಗಳನ್ನು ಸ್ವೀಕರಿಸುತ್ತದೆ.

ಕೀಲಿ ರಚಿಸುವುದು

Oblic ನಲ್ಲಿ ಸೆಟ್ಟಿಂಗ್‌ಗಳು → API ಏಕೀಕರಣ ಅಡಿಯಲ್ಲಿ ಕೀಲಿಗಳನ್ನು ರಚಿಸಿ. ಪ್ರತಿ ಕೀಲಿಗೆ ಹೆಸರು, ಪಾತ್ರ (Owner, Admin ಅಥವಾ User) ಮತ್ತು ಅದರ ಅಪ್ಲಿಕೇಶನ್‌ಗೆ ಬೇಕಾದ ಅನುಮತಿ ವ್ಯಾಪ್ತಿಗಳು ನೀಡಿ. ರಚಿಸುವಾಗ ಕೀಲಿಯನ್ನು ಒಮ್ಮೆ ಮಾತ್ರ ತೋರಿಸಲಾಗುತ್ತದೆ: ರಹಸ್ಯಗಳ ನಿರ್ವಾಹಕದಲ್ಲಿ ಅಥವಾ ರಕ್ಷಿತ ಪರಿಸರ ಚರದಲ್ಲಿ ಸಂಗ್ರಹಿಸಿ. ಕಳೆದುಹೋದ ಕೀಲಿಯನ್ನು ಮತ್ತೆ ತೋರಿಸಲಾಗುವುದಿಲ್ಲ; ಇನ್ನೊಂದು ರಚಿಸಿ ನಂತರ ಕಳೆದುಹೋದದ್ದನ್ನು ಅಳಿಸಿ.

ಕೀಲಿ ಕಳುಹಿಸುವುದು

Authorization ಹೆಡರ್‌ನಲ್ಲಿ Bearer, ಒಂದು ಖಾಲಿ ಜಾಗ ಮತ್ತು ನಂತರ ಕೀಲಿಯನ್ನು ಕಳುಹಿಸಿ:

ಕೀಲಿಯೊಂದಿಗೆ ಕರೆ

curl https://api.oblic.app/external/v1/key \
  -H 'Authorization: Bearer YOUR_API_KEY'

API ಸರ್ವರ್‌ಗಳಿಗಾಗಿ ಇದೆ: ಬ್ರೌಸರ್‌ನ ಕ್ರಾಸ್-ಒರಿಜಿನ್ ವಿನಂತಿಗೆ ಉತ್ತರಿಸುವುದಿಲ್ಲ. ಹೀಗಾಗಿ ಎಲ್ಲರೂ ಓದಬಹುದಾದ ವೆಬ್ ಪುಟ ಅಥವಾ ಅಪ್ಲಿಕೇಶನ್‌ನಲ್ಲಿ ಕೀಲಿಯನ್ನು ಇರಿಸುವ ಅಗತ್ಯವಿಲ್ಲ.

ಅನುಮತಿ ವ್ಯಾಪ್ತಿಗಳು

ಕೀಲಿ ರಚಿಸುವಾಗ ನೀಡಿದ ವ್ಯಾಪ್ತಿಗಳನ್ನು ಹೊಂದಿರುತ್ತದೆ. ಪ್ರತಿ ರೂಟ್ ತಾನು ಸ್ವೀಕರಿಸುವ ವ್ಯಾಪ್ತಿಗಳನ್ನು ಪಟ್ಟಿಮಾಡುತ್ತದೆ; ಅವುಗಳಲ್ಲಿ ಯಾವುದಾದರೂ ಒಂದನ್ನು ಹೊಂದಿರುವ ಕೀಲಿ ಅದನ್ನು ಕರೆಯಬಹುದು. ವ್ಯಾಪ್ತಿಗಳ ವ್ಯವಸ್ಥೆ ಬರುವ ಮೊದಲು ರಚಿಸಿದ ಕೀಲಿಯು ಸಂಪರ್ಕಗಳ ಘಟನೆಗಳನ್ನು ದಾಖಲಿಸುವ events:write ಹೊರತುಪಡಿಸಿ ಎಲ್ಲ ವ್ಯಾಪ್ತಿಗಳನ್ನು ಹೊಂದಿರುತ್ತದೆ. ಘಟನೆಗಳನ್ನು ಕಳುಹಿಸಲು ಈ ವ್ಯಾಪ್ತಿ ಹೊಂದಿರುವ ಕೀಲಿಯನ್ನು ರಚಿಸಿ.

ವ್ಯಾಪ್ತಿಕೀಲಿಗೆ ಅನುಮತಿಸುವುದು
email:sendಇಮೇಲ್ ಕಳುಹಿಸುವುದು ಮತ್ತು ಬಳಸುವ ಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್‌ಗಳು ಹಾಗೂ ಕಳುಹಿಸುವವರ ಗುರುತುಗಳನ್ನು ಓದುವುದು
sms:sendSMS ಕಳುಹಿಸುವುದು ಮತ್ತು SMS ಖಾತೆ, ಹೆಡರ್‌ಗಳು ಹಾಗೂ ಟೆಂಪ್ಲೇಟ್‌ಗಳನ್ನು ಓದುವುದು
whatsapp:sendWhatsApp ಸಂದೇಶ ಕಳುಹಿಸುವುದು ಮತ್ತು WhatsApp ಸಂಖ್ಯೆ, ಟೆಂಪ್ಲೇಟ್‌ಗಳು ಹಾಗೂ ಸ್ವೀಕರಿಸುವವರನ್ನು ಓದುವುದು
messages:readಸಂದೇಶಗಳ ಪಟ್ಟಿ, ಪ್ರತಿಯೊಂದರ ಫಲಿತಾಂಶ ಮತ್ತು ವರದಿಯ ಸಾರಾಂಶ ಓದುವುದು
templates:manageಇಮೇಲ್ ಟೆಂಪ್ಲೇಟ್‌ಗಳು, SMS ಹೆಡರ್‌ಗಳು ಹಾಗೂ ಟೆಂಪ್ಲೇಟ್‌ಗಳು ಮತ್ತು WhatsApp ಸಂಖ್ಯೆ ಹಾಗೂ ಟೆಂಪ್ಲೇಟ್‌ಗಳನ್ನು ನಿರ್ವಹಿಸುವುದು
identities:manageಕಳುಹಿಸುವವರ ಗುರುತುಗಳನ್ನು ನಿರ್ವಹಿಸುವುದು
contacts:manageಸಂಪರ್ಕ ಪಟ್ಟಿಗಳನ್ನು ರಚಿಸುವುದು, ಅವುಗಳ ಪಟ್ಟಿ ಪಡೆಯುವುದು ಮತ್ತು ಸಂಪರ್ಕಗಳನ್ನು ಸೇರಿಸುವುದು
events:writeಆರ್ಡರ್‌ಗಳಂತಹ ಸಂಪರ್ಕಗಳ ಘಟನೆಗಳನ್ನು ದಾಖಲಿಸುವುದು (ಘಟನೆಗಳು ನೋಡಿ)
webhooks:manageವೆಬ್‌ಹುಕ್‌ಗಳು ಮತ್ತು ಅವುಗಳ ವಿಫಲ ವಿತರಣೆಗಳನ್ನು ನಿರ್ವಹಿಸುವುದು
accounts:manageಉಪಖಾತೆಗಳನ್ನು ನಿರ್ವಹಿಸುವುದು

mcp:read ಮತ್ತು mcp:write Oblic ನ MCP ಸರ್ವರ್‌ಗಾಗಿ, ಈ API ಗಾಗಿ ಅಲ್ಲ. ಪ್ರತಿ ರೂಟ್‌ನ ವ್ಯಾಪ್ತಿಗಳು ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳಲ್ಲಿ ಮತ್ತು OpenAPI ದಾಖಲೆಯ x-oblic-scopes ನಲ್ಲಿ ನೀಡಲ್ಪಟ್ಟಿವೆ.

ಪಾತ್ರಗಳು

ವ್ಯಾಪ್ತಿಗಳು ಏನೇ ಇದ್ದರೂ ಕೀಲಿಯ ಪಾತ್ರವು ಅದಕ್ಕೆ ಲಭ್ಯವಿರುವ ರೂಟ್‌ಗಳನ್ನು ನಿರ್ಧರಿಸುತ್ತದೆ:

  • Owner ಮತ್ತು Admin ಕೀಲಿಗಳು ಎಲ್ಲ ರೂಟ್‌ಗಳನ್ನು ಕರೆಯಬಹುದು.
  • User ಕೀಲಿಗಳು ಟೆಂಪ್ಲೇಟ್‌ಗಳು, SMS ಹೆಡರ್‌ಗಳು ಅಥವಾ WhatsApp ಸಂಖ್ಯೆಯನ್ನು ಬದಲಿಸುವ, ವೆಬ್‌ಹುಕ್‌ಗಳು ಅಥವಾ ಉಪಖಾತೆಗಳನ್ನು ನಿರ್ವಹಿಸುವ ಮತ್ತು /external/v1/health ಪರಿಶೀಲಿಸುವ ರೂಟ್‌ಗಳ ಹೊರತು ಎಲ್ಲವನ್ನೂ ಕರೆಯಬಹುದು. User ಕೀಲಿಯನ್ನು templates:manage, webhooks:manage ಅಥವಾ accounts:manage ಜೊತೆಗೆ ರಚಿಸಲಾಗುವುದಿಲ್ಲ. ಎಲ್ಲ ವ್ಯಾಪ್ತಿಗಳಿರುವ ಹಳೆಯ ಅಥವಾ ಉಪಖಾತೆಯ ಕೀಲಿಯು ಅವುಗಳನ್ನು ಪಟ್ಟಿಮಾಡಿದರೂ ಬಳಸಲಾಗುವುದಿಲ್ಲ.

ಈ ರೂಟ್‌ಗಳಲ್ಲಿ ಅಗತ್ಯ ವ್ಯಾಪ್ತಿಗಳಲ್ಲಿ ಒಂದೂ ಇಲ್ಲದ User ಕೀಲಿಗೆ 403 INSUFFICIENT_SCOPE ಬರುತ್ತದೆ. 403 ROLE_NOT_ALLOWED ವ್ಯಾಪ್ತಿ ಅಗತ್ಯವಿಲ್ಲದ /external/v1/health ಮತ್ತು ಎಲ್ಲ ವ್ಯಾಪ್ತಿಗಳನ್ನು ಹೊಂದಿರುವ ಸಂದರ್ಭಗಳಲ್ಲಿ ಬರುತ್ತದೆ.

IP ಅನುಮತಿ ಪಟ್ಟಿ

ಸೆಟ್ಟಿಂಗ್‌ಗಳು → API ಏಕೀಕರಣ → ಶ್ವೇತಪಟ್ಟಿ ಮಾಡಲಾದ ಐಪಿಗಳು ಅಡಿಯಲ್ಲಿ ನಿಮ್ಮ ಸರ್ವರ್‌ಗಳು ಕರೆ ಮಾಡುವ ವಿಳಾಸಗಳನ್ನು ನಮೂದಿಸಿ: ಪ್ರತ್ಯೇಕ IPv4 ಅಥವಾ IPv6 ವಿಳಾಸಗಳು ಅಥವಾ 203.0.113.0/24 ನಂತಹ ಶ್ರೇಣಿಗಳು. ಪಟ್ಟಿ ಖಾಲಿಯಾಗಿರುವಾಗ ಕೀಲಿ ಯಾವುದೇ ವಿಳಾಸದಿಂದ ಕೆಲಸ ಮಾಡುತ್ತದೆ; ಒಂದು ನಮೂದು ಸೇರಿದ ಬಳಿಕ ಪಟ್ಟಿಯ ವಿಳಾಸಗಳಿಂದ ಮಾತ್ರ ಕೆಲಸ ಮಾಡುತ್ತದೆ. ಬದಲಾವಣೆ ಒಂದು ನಿಮಿಷದೊಳಗೆ ಅನ್ವಯಿಸುತ್ತದೆ.

ಬೇರೆ ವಿಳಾಸದ ವಿನಂತಿಗೆ 403 IP_NOT_ALLOWED ಬರುತ್ತದೆ. Oblic ಕಂಡ ವಿಳಾಸವನ್ನು ಸಂದೇಶ ತಿಳಿಸುತ್ತದೆ; ಅದನ್ನೇ ಸೇರಿಸಬೇಕು. ಉಪಖಾತೆಯ ವಿನಂತಿಗೂ ಸಂಸ್ಥೆಯ ಪಟ್ಟಿ ಅನ್ವಯಿಸುತ್ತದೆ.

GET/external/v1/key

ಕೀಲಿ ಪರಿಶೀಲಿಸುವುದು

ಯಾವುದೇ ಕೀಲಿ ತನ್ನ ಹೆಸರು, ಪಾತ್ರ, ವ್ಯಾಪ್ತಿಗಳು ಮತ್ತು ಪ್ರಸ್ತುತ ಲಭ್ಯವಿರುವ ಕ್ರಿಯೆಗಳನ್ನು ಓದಬಹುದು.

ಉತ್ತರದ ಒಂದು ಭಾಗ

{
  "status": "success",
  "data": {
    "name": "Order service",
    "role": "USER",
    "scopes": ["email:send", "messages:read"],
    "allScopes": false,
    "organizationId": "ORG000R7ZM4Q2VXH00",
    "capabilities": {
      "scopes": [
        { "scope": "email:send", "action": "send email", "ownerOnly": false, "granted": true, "ready": true }
      ],
      "verifiedSenders": [{ "identity": "example.com", "type": "Domain", "status": "verified" }],
      "unverifiedSenders": [],
      "defaultSender": "hello@example.com",
      "allowedIps": ["203.0.113.0/24"],
      "subAccount": false
    }
  },
  "errors": null
}

capabilities ಪ್ರತಿ ವ್ಯಾಪ್ತಿಯನ್ನು ಬಳಸಲು ಕೀಲಿಗೆ ಅನುಮತಿಯಿದೆಯೇ (granted) ಮತ್ತು ಸಂಸ್ಥೆ ಸಿದ್ಧವಾಗಿದೆಯೇ (ready) ಎಂದು ತಿಳಿಸುತ್ತದೆ. ಉದಾಹರಣೆಗೆ ಇಮೇಲ್ ಕಳುಹಿಸಲು ಪರಿಶೀಲಿಸಿದ ಕಳುಹಿಸುವವರು ಬೇಕು. ಸಿದ್ಧವಿಲ್ಲದ ಕಾರಣವನ್ನು reason ತಿಳಿಸುತ್ತದೆ.

ತಿರಸ್ಕಾರಗಳು

ಸ್ಥಿತಿcdಯಾವಾಗ
401MISSING_API_KEYAuthorization: Bearer ಹೆಡರ್ ಇಲ್ಲ
401INVALID_API_KEYOblic ಗೆ ತಿಳಿಯದ ಕೀಲಿ: ತಪ್ಪಾಗಿ ಬರೆದದ್ದು ಅಥವಾ ಅಳಿಸಿದ್ದು
403IP_NOT_ALLOWEDಮಾನ್ಯ ಕೀಲಿ, ಆದರೆ ವಿಳಾಸ IP ಅನುಮತಿ ಪಟ್ಟಿಯಲ್ಲಿ ಇಲ್ಲ
403INSUFFICIENT_SCOPEರೂಟ್‌ನ ಯಾವುದೇ ವ್ಯಾಪ್ತಿ ಕೀಲಿಯಲ್ಲಿ ಇಲ್ಲ; ಸಂದೇಶ ಮತ್ತು WWW-Authenticate ಹೆಡರ್ ಬೇಕಾದ ವ್ಯಾಪ್ತಿಗಳನ್ನು ತಿಳಿಸುತ್ತವೆ
403ROLE_NOT_ALLOWED/external/v1/health ನಲ್ಲಿ User ಕೀಲಿ ಅಥವಾ Owner ಅಥವಾ Admin ಗಾಗಿ ಇರುವ ರೂಟ್‌ನಲ್ಲಿ ಎಲ್ಲ ವ್ಯಾಪ್ತಿಗಳಿರುವ User ಕೀಲಿ
404ACCOUNT_NOT_FOUNDX-Oblic-On-Behalf-Of ಯಾವುದೇ ಸಕ್ರಿಯ ಉಪಖಾತೆಯನ್ನು ಸೂಚಿಸುವುದಿಲ್ಲ
503AUTHENTICATION_UNAVAILABLEOblic ಗೆ ಆ ಸಮಯದಲ್ಲಿ ಕೀಲಿಯನ್ನು ಪರಿಶೀಲಿಸಲಾಗಲಿಲ್ಲ; ಏನೂ ಮಾಡಿಲ್ಲ, ಮತ್ತೆ ಪ್ರಯತ್ನಿಸಿ

ಕೀಲಿಗಳನ್ನು ಸುರಕ್ಷಿತವಾಗಿಡುವುದು

  • ಪ್ರತಿ ಅಪ್ಲಿಕೇಶನ್ ಮತ್ತು ಪರಿಸರಕ್ಕೆ ಪ್ರತ್ಯೇಕ ಕೀಲಿ ಬಳಸಿ, ಅಗತ್ಯ ವ್ಯಾಪ್ತಿಗಳೊಂದಿಗೆ ಮಾತ್ರ. ಕೀಲಿ ಸೋರಿಕೆಯ ಪರಿಣಾಮ ಸೀಮಿತವಾಗಿರುತ್ತದೆ; ಅಳಿಸಿದಾಗ ಒಂದೇ ಅಪ್ಲಿಕೇಶನ್ ನಿಲ್ಲುತ್ತದೆ.
  • ಕೀಲಿಗಳನ್ನು ಸರ್ವರ್‌ನಲ್ಲಿ ಇರಿಸಿ, ಕೋಡ್, ಲಾಗ್‌ಗಳು ಅಥವಾ ಬ್ರೌಸರ್ ಮತ್ತು ಅಪ್ಲಿಕೇಶನ್ ಡೌನ್‌ಲೋಡ್ ಮಾಡುವ ಯಾವುದರಲ್ಲೂ ಅಲ್ಲ.
  • ಕೀಲಿ ಬದಲಿಸಲು ಹೊಸದನ್ನು ರಚಿಸಿ, ನಿಯೋಜಿಸಿ ಮತ್ತು ನಂತರ ಹಳೆಯದನ್ನು ಅಳಿಸಿ. ಅಳಿಸಿದ ಕೀಲಿ ತಕ್ಷಣ ಕೆಲಸ ಮಾಡುವುದನ್ನು ನಿಲ್ಲಿಸುತ್ತದೆ.
ಈ ಪುಟವು ಸಹಾಯಕವಾಗಿದೆಯೇ?