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 ਵਜੋਂ, ਜਾਂ ਜਨਤਕ ਮੇਲ ਦਾ Email ਜਦੋਂ Oblic ਦਾ ਭੇਜਣ ਵਾਲਾ ਡੋਮੇਨ ਸੰਰਚਿਤ ਨਹੀਂ ਹੈ
400OBLIC_DOMAINOblic ਦਾ ਕੋਈ ਆਪਣਾ ਡੋਮੇਨ
400IDENTITY_LIMIT_REACHEDਈਮੇਲ ਪ੍ਰਦਾਤਾ ਦੀ ਮਨਜ਼ੂਰ ਪਛਾਣਾਂ ਦੀ ਵੱਧ ਤੋਂ ਵੱਧ ਗਿਣਤੀ ਪੂਰੀ ਹੋ ਗਈ ਹੈ
503EMAIL_PROVIDER_UNAVAILABLEਈਮੇਲ ਪ੍ਰਦਾਤਾ ਤੱਕ ਪਹੁੰਚ ਨਹੀਂ ਹੋ ਸਕੀ; ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਕਰੋ

GET/external/v1/identities

ਪਛਾਣਾਂ ਦੀ ਸੂਚੀ ਵੇਖਣਾ

ਖਾਤੇ ਦੀਆਂ ਪਛਾਣਾਂ, ਕਾਲ ਤੋਂ ਪਹਿਲਾਂ ਤਸਦੀਕਸ਼ੁਦਾ ਪਹਿਲਾਂ। ਸੂਚੀ ਲੈਂਦੇ ਸਮੇਂ ਬਾਕੀ ਪਛਾਣਾਂ ਦੀ ਦੁਬਾਰਾ ਜਾਂਚ ਹੁੰਦੀ ਹੈ, ਅਤੇ ਇਸ ਜਾਂਚ ਵਿੱਚ ਤਸਦੀਕ ਹੋਈ ਪਛਾਣ ਉਸੇ ਜਵਾਬ ਵਿੱਚ SUCCESS ਵਜੋਂ ਦਿਖਦੀ ਹੈ।


DELETE/external/v1/identities/{identityId}

ਪਛਾਣ ਮਿਟਾਉਣਾ

ਪਛਾਣ ਭੇਜਣਾ ਬੰਦ ਕਰ ਦਿੰਦੀ ਹੈ, ਅਤੇ Oblic ਰਾਹੀਂ ਭੇਜੇ ਜਾਣ ਵਾਲੇ ਪਤੇ ਦੀ ਪੁਸ਼ਟੀ ਵੀ ਖ਼ਤਮ ਹੋ ਜਾਂਦੀ ਹੈ: ਦੁਬਾਰਾ ਜੋੜਨ ਉੱਤੇ ਫਿਰ ਪੁਸ਼ਟੀ ਕਰਨੀ ਪੈਂਦੀ ਹੈ। ਖਾਤੇ ਵਿੱਚ ਉਹ ਪਛਾਣ ਸੀ ਜਾਂ ਨਹੀਂ, ਜਵਾਬ 200 ਹੁੰਦਾ ਹੈ।

ਕੀ ਇਹ ਪੰਨਾ ਮਦਦਗਾਰ ਸੀ?