Genel e-posta kutularının API aracılığıyla yönetimi

Paylaşılan posta kutusu, belirli bir sahibi olmayan bir posta kutusudur: örneğin aynı bölümden birkaç çalışan tarafından kullanılır.

Bir organizasyonda ilişkilendirilmiş alan adı yoksa, paylaşılan posta kutuları oluşturulamaz. Bir alan adı nasıl ilişkilendirilir?

Paylaşılan bir posta kutusu oluşturma ve yapılandırma

Adım 1. API ile çalışmaya hazırlanın

  1. API ile çalışmak için Yandex OAuth servisinde bir uygulama oluşturduktan sonra elde edilebilecek OAuth-belirteci'ne ihtiyacınız olacaktır.

    • Henüz bir OAuth uygulamanız yoksa, bir tane oluşturmak ve bir belirteç almak için API’ye Erişim sayfasındaki talimatları kullanın. Uygulamayı oluştururken ya360_admin:mail_read_shared_mailbox_inventory ve ya360_admin:mail_write_shared_mailbox_inventory yetkilerini seçin.
    • Yandex 360 API for Business ile çalışmak için zaten bir OAuth uygulamanız varsa, posta kutusu erişim ayarlarını görüntülemek ve değiştirmek için ona yetkiler ekleyin ve ardından talimatlara göre yeni bir OAuth belirteci alın.

  2. API istekleri için gerekli olan verileri toplayın.

    1. Organizasyonun kimliğini belirleyin: Kuruluş paneli ’i açın ve Genel ayarlar → Organizasyon profili ’ni seçin. Kimlik, organizasyonun adının altına yazılacaktır.

    2. Erişim izni verilmesi gereken çalışanın kimliğini tanımlayın. Kimliği tanımlamak için:

      1. Kullanıcılar → Çalışanlar ’ı seçin.

      2. İlgili çalışanın satırını bulun ve adına tıklayın.

      3. Çalışan girişi üzerine sağ tıklayın ve bağlantı adresini kopyalayın.

      4. Adresi herhangi bir metin düzenleyicisine yapıştırın. Kimlik – adresin uid=’den sonraki kısmıdır. Örneğin, şu adresten:

        https://staff.yandex.ru/bb?org_id=5487632&uid=2260000054273165

        2260000054273165 kimliği elde edilir.

        Çalışan kimliklerini API üzerinden de tanımlamak mümkün mü?

        Elbette. Bunların listesini arattıran bir istek vardır. Belgeleri görüntüleyin

Adım 2. Paylaşılan bir posta kutusu oluşturun

  1. İstekte kullanılacak verileri içeren parameters.json adlı bir dosya hazırlayın. Bu işlem herhangi bir metin düzenleyicide yapılabilir. Dosyada, oluşturulacak ortak posta kutusunun parametrelerini aşağıdaki formatta belirtin:

    {
   "email": "{ADRES}",
   "name": "{AD}",
   "description": "{AÇIKLAMA}"
}

    Burada
    {ADRES} ortak posta kutusunun e-posta adresidir;
    {AD} ortak posta kutusunun adıdır;
    {AÇIKLAMA} ortak posta kutusunun kısa bir açıklamasıdır.

  2. Paylaşılan bir posta kutusu oluşturmak için bir istek oluşturun ve gönderin:

    • HTTP yöntemi: PUT

    • İstek URL’si:

      https://api360.yandex.net/admin/v1/org/{ORGANİZASYON}/mailboxes/shared

      Burada {ORGANİZASYON} – “API ile Çalışmaya Hazırlık” talimatının 2.1 adımında elde edilen organizasyon kimliğidir.

      Örnek
      https://api360.yandex.net/admin/v1/org/1234567/mailboxes/shared

    • Başlıklar:

      Authorization: OAuth {OAUTH-BELİRTEÇ}
Content-Type: application/json

      Burada {OAUTH- BELİRTEÇ} – “API ile Çalışmaya Hazırlık” talimatının 1 adımında alınan OAuth belirtecidir.

    • İstek metni: Bu talimatların 1 adımında oluşturulan## parameters.json## dosyasında yer alır.

    Windows üzerinde çalışıyorsanız, aşağıdaki şekildeki bir curl komutunu kullanarak posta kutusu temsilci atama için bir izin isteği gönderebilirsiniz:

    curl -X PUT -H "Authorization: OAuth {OAUTH-BELİRTEÇ}" -H "Content-Type: application/json" -d "@parameters.json" https://api360.yandex.net/admin/v1/org/{ORGANİZASYON}/mailboxes/delegated

    Burada
    {OAUTH-BELİRTEÇ} – “API ile Çalışmaya Hazırlık” talimatının 1 adımında elde edilen OAuth belirtecidir;
    parameters.json – bu talimatın 1 adımında oluşturulan istek metni dosyasıdır;
    {ORGANİZASYON} – “API ile Çalışmaya Hazırlık” talimatının 2.1 adımında elde edilen organizasyon kimliğidir.

    Bunun nasıl yapılacağını anlamıyorum

    1. Komutu hazırlayın: Örneği herhangi bir düzenleyiciye kopyalayın, belirteci ve kimlikleri belirtilen yerlere yapıştırın.

    2. parameters.json dosyasının bulunduğu klasörü açın.

    3. Adres satırındaki boş alana tıklayın.

    4. Buraya cmd yazın ve Enter tuşuna basın.

    5. “Komut Satırı” penceresi açılacaktır. Hazır komutu içine yapıştırın ve Enter tuşuna basın.

  3. Alınan yanıtı analiz edin: İsteğin başarılı olması halinde, yanıtta oluşturulan paylaşılan posta kutusunun kimliğini gösteren 200 OK durumunu alacaksınız. Elde edilen kimliği kaydedin.

Adım 3. Erişim sağlayın

Grup işlemleri erişim verme konusunda henüz desteklenmemektedir. İstek başına yalnızca bir çalışan için bir posta kutusuna erişim hakkı verebilir, değiştirebilir veya silebilirsiniz. Ancak aynı anda birden fazla istekte bulunabilirsiniz.

  1. İstekte kullanılacak verileri içeren roles.json adlı bir dosya hazırlayın. Bu işlem herhangi bir metin düzenleyicide yapılabilir. Dosyada, posta kutusuna erişim yetkisi verilen çalışanın rollerini belirtin. Rollerin açıklaması Roller ve erişim yetkileri bölümünde yer almaktadır.

    Örnek dosya roles.json:

    {
   "roles": [
      "shared_mailbox_imap_admin",
      "shared_mailbox_half_sender"
   ]
}

    shared_mailbox_sender veya shared_mailbox_owner rollerinden biri listede bulunmalıdır, çünkü bunlar e-postaları okumaktan sorumludur.

  2. Bir API isteği ile, çalışanlara, paylaşılan bir posta kutusuna erişim yetkisi verin:

    • HTTP yöntemi: POST

    • İstek URL’si:

      https://api360.yandex.net/admin/v1/org/{ORGANİZASYON}/mailboxes/set/{ЯЩИК}?actorId={ERİŞİM HAKKI OLAN ÇALIŞAN}&notify={BİLDİRİM GÖNDERME PARAMETRESİ}

      Burada
      {ORGANISATION} – “API ile Çalışmaya Hazırlık” talimatının 2.1 adımında elde edilen organizasyonun kimliğidir;
      {POSTA KUTUSU} – Posta Kutusu Oluşturma talimatı ile oluşturulan paylaşılan posta kutusunun kimliğidir;
      {ERİŞİMİ OLAN ÇALIŞAN} – “API ile Çalışmaya Hazırlık” talimatının 2.2 adımında elde edilen, posta kutusuna erişim yetkisi verilmesi gereken çalışanın kimliğidir;
      {BİLDİRİM GÖNDERME PARAMETRESİ} – posta kutusuna erişim yetkilerinin değiştirilmesi hakkında kime bildirim e-postası gönderilmesi gerektiğini tanımlayan parametredir. Olası değerler: all, delegates, none. Parametre değerlerinin açıklaması Bildirimler bölümünde yer almaktadır.

      Örnek
      https://api360.yandex.net/admin/v1/org/1234567/mailboxes/mailboxes/set/2260000054273165?actorId=3340000075421587&notify=all

    • Başlıklar:

      Authorization: OAuth {OAUTH-BELİRTEÇ}
Content-Type: application/json

      Burada {OAUTH- BELİRTEÇ} – “API ile Çalışmaya Hazırlık” talimatının 1 adımında alınan OAuth belirtecidir.

    • İstek metni: Bu talimatların 1 adımında oluşturulan## roles.json## dosyasında yer alır.

    Windows üzerinde çalışıyorsanız, aşağıdaki şekildeki bir curl komutunu kullanarak posta kutusu temsilci atama için bir izin isteği gönderebilirsiniz:

    curl -X POST -H "Authorization: OAuth {OAUTH BELİRTECİ}" -H "Content-Type: application/json" -d "@roles.json" https://api360.yandex.net/admin/v1/org/{ORGANİZASYON}/mailboxes/set/{SAHİBİ}?actorId={ERİŞİM HAKKI OLAN ÇALIŞAN}&notify={BİLDİRİM GÖNDERME PARAMETRESİ}

    Burada
    {OAUTH-BELİRTEÇ} – “API ile Çalışmaya Hazırlık” talimatının 1 adımında elde edilen OAuth belirtecidir;
    roles.json bu talimatın 1 adımında oluşturulan istek metni dosyasıdır;
    {ORGANİZASYON} – “API ile Çalışmaya hazırlık” talimatının 2.1 adımında elde edilen organizasyon kimliğidir;
    {POSTA KUTUSU} – Posta Kutusu Oluşturma talimatına göre oluşturulan, paylaşılan posta kutusunun kimliğidir;
    {ERİŞİMİ OLAN ÇALIŞAN} – “API ile Çalışmaya Hazırlık” talimatının 2.2 adımında elde edilen, posta kutusuna erişim yetkisi verilmesi gereken çalışanın kimliğidir;
    {BİLDİRİM GÖNDERME PARAMETRESİ} – posta kutusuna erişim yetkilerinin değiştirilmesiyle ilgili bildirim e-postasının kime gönderilmesi gerektiğini tanımlayan parametredir. Olası değerler: all, delegates, none. Parametre değerlerinin açıklaması Bildirimler bölümünde yer almaktadır.

  3. Alınan yanıtı analiz edin: İsteğin başarılı olması durumunda, yanıtta 200 OK durumunu ve yetki değişikliği için görev kimliğini alırsınız. Elde edilen kimliği kaydedin.

  4. Erişim yetkisi verildiğinden emin olmak için, görev kimliğini değiştirerek başka bir istek gönderin:

    curl -X GET -H "Yetkilendirme: OAuth {OAUTH-BELİRTEÇ}" https://api360.yandex.net/admin/v1/org/{ORGANİZASYON}/mailboxes/tasks/{ID TASKS}

    Yanıt olarak, yetkileri değiştirme görevinin durumunu alacaksınız. Yanıt complete değeriyle gelirse yetkiler başarıyla değiştirilmiş demektir.

Adım 4 Çalışanlara e-posta kurulumu konusunda yardımcı olun

E-posta istemcilerinin ayarlanmasıyla ilgili talimatlar E-posta programlarında posta kutularının paylaşılması bölümünde yer almaktadır.

Erişimin devre dışı bırakılması

Belirli bir çalışanın posta kutusuna erişimini devre dışı bırakmak için, erişim verme talimatlarının adımlarını uygulayın, sadece mevcut rollerin listesini içeren roles.json dosyasında aşağıdaki şekilde boş bir liste belirtin:

   {
"roles": []
}

Posta kutusu silme

Bir DELETE isteği kullanarak paylaşılan bir posta kutusunu silebilirsiniz:

curl -X DELETE -H "Authorization: OAuth {OAUTH-BELİRTEÇ}" https://api360.yandex.net/admin/v1/org/{ORGANİZASYON}/mailboxes/shared/{POSTA KUTUSU}

API belgeleri

Erişim yönetimine ilişkin tüm yöntemlerin tam açıklamasını belgelerde bulabilirsiniz.

Destek Ekibi'ne yaz

Belirli bir kullanıcı adına verilere erişime izin veren özel kod.