Oblic

ಕಳುಹಿಸುವವರ ಗುರುತುಗಳು

ಇಮೇಲ್ ಖಾತೆಯ ಕಳುಹಿಸುವವರ ಗುರುತುಗಳಲ್ಲಿ ಒಂದರಿಂದ ಕಳುಹಿಸಲಾಗುತ್ತದೆ: ಅದರ ಸ್ವಂತ ಡೊಮೇನ್ ಅಥವಾ ವಿಳಾಸ. Oblic ಪರಿಶೀಲಿತ ಗುರುತಿನಿಂದ ಮಾತ್ರ ಕಳುಹಿಸುತ್ತದೆ. ಗುರುತು ಸೇರಿಸಲು ಮತ್ತು ಅಳಿಸಲು ಕೀಲಿಯಲ್ಲಿ identities:manage ಬೇಕು; ಪಟ್ಟಿಯನ್ನು ನೋಡಲು identities:manage ಅಥವಾ email:send ಬೇಕು.


POST/external/v1/identities

ಗುರುತು ಸೇರಿಸುವುದು

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

    ಅಗತ್ಯ: Domain ಅಥವಾ Email, ದೊಡ್ಡ ಮತ್ತು ಸಣ್ಣ ಅಕ್ಷರಗಳನ್ನು ಇದೇ ರೀತಿ ಬಳಸಿ.

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

    ಅಗತ್ಯ: example.com ನಂತಹ ಡೊಮೇನ್ ಅಥವಾ orders@example.com ನಂತಹ ವಿಳಾಸ, ಗರಿಷ್ಠ 255 ಅಕ್ಷರಗಳು.

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

    Domain ಗೆ ಅಗತ್ಯ: ಗುರುತು ಕಳುಹಿಸುವ ಅದೇ ಡೊಮೇನ್‌ನ ವಿಳಾಸ.

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

    ಅಗತ್ಯ: ಕಳುಹಿಸುವವರ ಹೆಸರು, ಗರಿಷ್ಠ 255 ಅಕ್ಷರಗಳು; <, >, " ಅಥವಾ ಸಾಲು ವಿರಾಮ ಇರಬಾರದು.

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

    ಪ್ರತ್ಯುತ್ತರಗಳನ್ನು ಕಳುಹಿಸುವ ವಿಳಾಸ.

ಡೊಮೇನ್ ಸೇರಿಸುವುದು

curl -X POST https://api.oblic.app/external/v1/identities \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityType": "Domain",
    "identity": "example.com",
    "email": "orders@example.com",
    "displayName": "Example Store"
  }'

ಪ್ರತಿಕ್ರಿಯೆಯಲ್ಲಿ ಗುರುತು ಸಿಗುತ್ತದೆ. ಡೊಮೇನ್‌ಗೆ payload ಪ್ರಕಟಿಸಬೇಕಾದ DNS ದಾಖಲೆಗಳನ್ನು ಹೊಂದಿರುತ್ತದೆ; ಪ್ರತಿಯೊಂದು key ಯಿಂದ value ಗೆ ಹೋಗುವ CNAME: ಮೊದಲು ಇಮೇಲ್ ಪೂರೈಕೆದಾರರ ಮೂರು DKIM ದಾಖಲೆಗಳು, ನಂತರ Oblic ನ ಸ್ವಂತ ದಾಖಲೆ.

ಪ್ರತಿಕ್ರಿಯೆಯ ಭಾಗ

{
  "status": "success",
  "data": {
    "id": "OEM000R7ZM4Q2VXH00",
    "email": "orders@example.com",
    "displayName": "Example Store",
    "domain": "example.com",
    "verificationStatus": "PENDING",
    "sendingMode": "OWN",
    "payload": [
      { "key": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw._domainkey.example.com", "value": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw.dkim.amazonses.com" },
      { "key": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj._domainkey.example.com", "value": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj.dkim.amazonses.com" },
      { "key": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n._domainkey.example.com", "value": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n.dkim.amazonses.com" },
      { "key": "_9f86d081884c4d659a2feaa0c55ad015.example.com", "value": "2c26b46b68ffc68ff99b453c1d304134.qwertyui.validation.oblic.app" }
    ]
  },
  "errors": null
}

ಖಾತೆಯಲ್ಲಿ ಈಗಾಗಲೇ ಇರುವ ಗುರುತನ್ನು ಸೇರಿಸಿದರೆ ಅದರ ಪ್ರಸ್ತುತ ಸ್ಥಿತಿ ಮರಳುತ್ತದೆ. ಮೌಲ್ಯವಿಲ್ಲದ ಕ್ಷೇತ್ರವನ್ನು ಬಿಡಲಾಗುತ್ತದೆ.


ಗುರುತನ್ನು ಪರಿಶೀಲಿಸುವುದು

  • ಡೊಮೇನ್ ಅದರ DNS ದಾಖಲೆಗಳನ್ನು ಪ್ರಕಟಿಸಿದಾಗ ಪರಿಶೀಲಿತವಾಗುತ್ತದೆ: DKIM ದಾಖಲೆಗಳಿಂದ ಪೂರೈಕೆದಾರರು ಇಮೇಲ್‌ಗೆ ಸಹಿ ಹಾಕುತ್ತಾರೆ; Oblic ನ ಸ್ವಂತ ದಾಖಲೆಯು ಡೊಮೇನ್ ಖಾತೆಯದು ಎಂದು ಸಾಬೀತುಪಡಿಸುತ್ತದೆ. ಪರಿಶೀಲಿತ ಡೊಮೇನ್‌ನ ಪ್ರತಿಯೊಂದು ವಿಳಾಸವೂ ಕಳುಹಿಸಬಹುದು.
  • ವಿಳಾಸಕ್ಕೆ ಇಮೇಲ್ ಪೂರೈಕೆದಾರರ ಲಿಂಕ್ ಬರುತ್ತದೆ; ಅದನ್ನು ಮಾಲೀಕರು ತೆರೆಯುತ್ತಾರೆ. ಅದರ ಡೊಮೇನ್ ಕೂಡ ಖಾತೆಯ ಡೊಮೇನ್ ಗುರುತಾಗಿ ಪರಿಶೀಲಿತವಾದಾಗ ಅದು ಕಳುಹಿಸಬಹುದು.
  • Gmail ಅಥವಾ Outlook ನಂತಹ ಸಾರ್ವಜನಿಕ ಮೇಲ್ ಸೇವೆಯ ವಿಳಾಸ DNS ದಾಖಲೆಗಳನ್ನು ಪ್ರಕಟಿಸಲು ಸಾಧ್ಯವಿಲ್ಲ; ಮತ್ತೊಬ್ಬ ಪೂರೈಕೆದಾರರ ಮೂಲಕ ಅದರ ಹೆಸರಿನಲ್ಲಿ ಕಳುಹಿಸಿದ ಇಮೇಲ್ ಪರಿಶೀಲನೆಯಲ್ಲಿ ವಿಫಲವಾಗುತ್ತದೆ. ಆದ್ದರಿಂದ Oblic ತನ್ನ ಸೇವೆಯ ಮೂಲಕ ಕಳುಹಿಸುತ್ತದೆ, ಇಲ್ಲಿ sendingMode ಮೌಲ್ಯ OBLIC: Oblic ನ ಸ್ವಂತ ಕಳುಹಿಸುವ ಡೊಮೇನ್‌ನಿಂದ “ನಿಮ್ಮ ಹೆಸರು via Oblic” ಎಂಬ ಹೆಸರಿನಲ್ಲಿ, ಪ್ರತ್ಯುತ್ತರಗಳನ್ನು ಮೂಲ ವಿಳಾಸಕ್ಕೆ ಕಳುಹಿಸಲಾಗುತ್ತದೆ. ಮಾಲೀಕತ್ವವನ್ನು ದೃಢೀಕರಿಸಲು Oblic ಆ ವಿಳಾಸಕ್ಕೆ 72 ಗಂಟೆಗಳವರೆಗೆ ಮಾನ್ಯವಾಗಿರುವ ಲಿಂಕ್ ಕಳುಹಿಸುತ್ತದೆ; ಅದನ್ನು ತೆರೆಯುವವರೆಗೆ ಗುರುತು ಕಳುಹಿಸಲು ಸಾಧ್ಯವಿಲ್ಲ. ಸಾರ್ವಜನಿಕ ಮೇಲ್ ಸೇವೆಯ ಡೊಮೇನ್ ಅನ್ನು Domain ಆಗಿ ಸೇರಿಸಲಾಗುವುದಿಲ್ಲ. ಈ ಮೋಡ್‌ಗೆ Oblic ನ ಕಳುಹಿಸುವ ಡೊಮೇನ್ ಸಂರಚನೆ ಅಗತ್ಯ; ಇಲ್ಲದಿದ್ದರೆ ವಿಳಾಸವನ್ನು PUBLIC_MAILBOX_DOMAIN ನೊಂದಿಗೆ ನಿರಾಕರಿಸಲಾಗುತ್ತದೆ.
  • Oblic ನ ಸ್ವಂತ ಡೊಮೇನ್‌ಗಳು ಯಾವುದೇ ಖಾತೆಯ ಗುರುತಾಗಲು ಸಾಧ್ಯವಿಲ್ಲ.

ಗುರುತು ಕಳುಹಿಸಬಹುದಾದಾಗ verificationStatus ಮೌಲ್ಯ SUCCESS ಆಗಿರುತ್ತದೆ; ಅಲ್ಲಿಯವರೆಗೆ PENDING ಆಗಿರುತ್ತದೆ.

ನಿರಾಕರಣೆcdಯಾವಾಗ
400INVALID_IDENTITYEmail ಗುರುತು ಇಮೇಲ್ ವಿಳಾಸವಲ್ಲ ಅಥವಾ ಡೊಮೇನ್‌ನ email ಅದೇ ಡೊಮೇನ್‌ಗೆ ಸೇರಿಲ್ಲ
400PUBLIC_MAILBOX_DOMAINಸಾರ್ವಜನಿಕ ಮೇಲ್ ಸೇವೆಯ ಡೊಮೇನ್, ಉದಾಹರಣೆಗೆ gmail.com, Domain ಆಗಿ, ಅಥವಾ Oblic ನ ಕಳುಹಿಸುವ ಡೊಮೇನ್ ಸಂರಚಿಸದಿದ್ದಾಗ ಸಾರ್ವಜನಿಕ ಮೇಲ್‌ನ Email ಬಳಸಿದರೆ
400OBLIC_DOMAINOblic ನ ಸ್ವಂತ ಡೊಮೇನ್‌ಗಳಲ್ಲಿ ಒಂದು
400IDENTITY_LIMIT_REACHEDಇಮೇಲ್ ಪೂರೈಕೆದಾರರು ಅನುಮತಿಸಿದ ಗುರುತುಗಳ ಗರಿಷ್ಠ ಸಂಖ್ಯೆಯನ್ನು ತಲುಪಿದ್ದಾರೆ
503EMAIL_PROVIDER_UNAVAILABLEಇಮೇಲ್ ಪೂರೈಕೆದಾರರನ್ನು ಸಂಪರ್ಕಿಸಲಾಗಲಿಲ್ಲ; ಮತ್ತೆ ಪ್ರಯತ್ನಿಸಿ

GET/external/v1/identities

ಗುರುತುಗಳ ಪಟ್ಟಿ ನೋಡುವುದು

ಖಾತೆಯ ಗುರುತುಗಳು, ಕರೆಗೆ ಮೊದಲು ಪರಿಶೀಲಿತವಾದವು ಮೊದಲು. ಪಟ್ಟಿಯನ್ನು ಪಡೆಯುವಾಗ ಬಾಕಿ ಇರುವ ಗುರುತುಗಳನ್ನು ಮತ್ತೆ ಪರಿಶೀಲಿಸಲಾಗುತ್ತದೆ; ಈ ಪರಿಶೀಲನೆಯಲ್ಲಿ ಪರಿಶೀಲಿತವಾದ ಗುರುತು ಅದೇ ಉತ್ತರದಲ್ಲಿ SUCCESS ಎಂದು ಪಟ್ಟಿಯಾಗುತ್ತದೆ.


DELETE/external/v1/identities/{identityId}

ಗುರುತು ಅಳಿಸುವುದು

ಗುರುತು ಕಳುಹಿಸುವುದನ್ನು ನಿಲ್ಲಿಸುತ್ತದೆ; Oblic ಮೂಲಕ ಕಳುಹಿಸುವ ವಿಳಾಸದ ದೃಢೀಕರಣವೂ ಕೊನೆಗೊಳ್ಳುತ್ತದೆ. ಮತ್ತೆ ಸೇರಿಸಿದರೆ ಮತ್ತೆ ದೃಢೀಕರಿಸಬೇಕು. ಖಾತೆಯಲ್ಲಿ ಆ ಗುರುತು ಇದ್ದರೂ ಇಲ್ಲದಿದ್ದರೂ ಪ್ರತಿಕ್ರಿಯೆ 200 ಆಗಿರುತ್ತದೆ.

ಈ ಪುಟವು ಸಹಾಯಕವಾಗಿದೆಯೇ?