অ্যাডমিন সেটিংস API ওভারভিউ

অ্যাডমিন সেটিংস API, Google Workspace ডোমেনের অ্যাডমিনিস্ট্রেটরদের Google Data API ফিডের আকারে তাদের ডোমেনের সেটিংস পুনরুদ্ধার এবং পরিবর্তন করার অনুমতি দেয়।

এই ডোমেন সেটিংসে Google Workspace অ্যাডমিন কনসোলে উপলব্ধ অনেক বৈশিষ্ট্য অন্তর্ভুক্ত রয়েছে। এই API-এর ব্যবহারের উদাহরণ হল একটি কাস্টম কন্ট্রোল প্যানেল তৈরি করা বা Google Workspace ডোমেনগুলিকে একটি বিদ্যমান লিগ্যাসি পরিবেশে একীভূত করা।

অ্যাডমিন সেটিংস API গুগল ডেটা এপিআই প্রোটোকল বাস্তবায়ন করে। গুগল ডেটা এপিআই অ্যাটম পাবলিশিং প্রোটোকল (এটমপাব) প্রকাশনা এবং সম্পাদনা মডেলের সাথে সঙ্গতিপূর্ণ। অ্যাটমপাব HTTP অনুরোধগুলি ওয়েব পরিষেবাগুলিতে প্রতিনিধিত্বমূলক সেট ট্রান্সফার (RESTful) ডিজাইন পদ্ধতি ব্যবহার করে। আরও তথ্যের জন্য, গুগল ডেটা ডেভেলপারের নির্দেশিকা দেখুন।

পাঠকবর্গ

এই ডকুমেন্টটি এমন ডেভেলপারদের জন্য তৈরি যারা ক্লায়েন্ট অ্যাপ্লিকেশন লিখতে চান যা Google Workspace ডোমেন সম্পর্কে তথ্য পরিবর্তন এবং পুনরুদ্ধার করতে পারে। এটি raw XML এবং HTTP ব্যবহার করে মৌলিক অ্যাডমিন সেটিংস API ইন্টারঅ্যাকশনের উদাহরণ প্রদান করে।

এই ডকুমেন্টটি ধরে নিয়েছে যে আপনি Google Data API প্রোটোকলের পিছনের সাধারণ ধারণাগুলি বোঝেন এবং আপনি Google Workspace অ্যাডমিন কনসোলের সাথে পরিচিত। অ্যাডমিন কনসোল সম্পর্কে আরও তথ্যের জন্য, "আপনার অ্যাডমিন কনসোল ব্যবহার করুন" দেখুন।

শুরু করা

একটি অ্যাকাউন্ট তৈরি করা হচ্ছে

Google Workspace অ্যাকাউন্টের জন্য Admin Settings API সক্রিয় করা আছে। পরীক্ষার উদ্দেশ্যে একটি Google Workspace অ্যাকাউন্টের জন্য সাইন আপ করুন। Admin Settings পরিষেবা Google Accounts ব্যবহার করে, তাই যদি আপনার ইতিমধ্যেই Google Workspace ডোমেনে একটি অ্যাকাউন্ট থাকে, তাহলে আপনার সবকিছু প্রস্তুত।

অ্যাডমিন সেটিংস API ফিডের ধরণ সম্পর্কে

অ্যাডমিন সেটিংস API আপনাকে ডোমেন সেটিংসের এই বিভাগগুলি পরিচালনা করতে দেয়:

একক সাইন-অন সেটিংস

SAML-ভিত্তিক একক সাইন-অন (SSO) ব্যবহারকারীদের Google Workspace হোস্ট করা পরিষেবাগুলির পাশাপাশি আপনার প্রতিষ্ঠানের মধ্যে হোস্ট করা অন্যান্য পরিষেবাগুলির জন্য একই লগইন এবং পাসওয়ার্ড ব্যবহার করার অনুমতি দেয়। বিশেষ করে SSO ব্যবহার করার সময়, Google Workspace-এর মতো একটি হোস্ট করা ওয়েব অ্যাপ্লিকেশন ব্যবহারকারীদের লগ ইন করার সময় প্রমাণীকরণের জন্য আপনার প্রতিষ্ঠানের পরিচয় প্রদানকারীর কাছে পুনঃনির্দেশিত করে। বিস্তারিত তথ্যের জন্য, Google Workspace-এর জন্য SAML-ভিত্তিক SSO বোঝা দেখুন।

SSO কনফিগার করার জন্য Google Workspace পরিষেবার জন্য প্রয়োজনীয় তথ্য প্রবেশ করানো জড়িত যা আপনার ব্যবহারকারীদের লগইন তথ্য সংরক্ষণ করে এমন পরিচয় প্রদানকারীর সাথে যোগাযোগ করতে পারে, সেইসাথে লগ ইন, লগ আউট এবং তাদের পাসওয়ার্ড পরিবর্তন করার জন্য ব্যবহারকারীদের যে লিঙ্কগুলিতে পাঠানো উচিত তা সেট আপ করা। অ্যাডমিন সেটিংস API আপনাকে প্রোগ্রাম্যাটিকভাবে এই সেটিংস আপডেট এবং পুনরুদ্ধার করতে দেয়। Google আপনার জেনারেটেড পাবলিক কী ব্যবহার করে আপনার পরিচয় প্রদানকারীর সাথে এই SSO অনুরোধটি যাচাই করে এবং নেটওয়ার্ক ট্রান্সমিশনের সময় ব্যক্তিগত কী SAML প্রতিক্রিয়া পরিবর্তন করা হয়নি।

SSO সেটিংস ব্যবহারের একটি সংক্ষিপ্ত API নির্দিষ্ট সারাংশের জন্য, আপনার পরিচয় প্রদানকারীর কাছ থেকে আপনার পাবলিক কী সার্টিফিকেট পান, Google-এ পাবলিক কী নিবন্ধন করুন এবং আপনার SAML-ভিত্তিক SSO কোয়েরি সেটিংস সেট আপ করুন। ত্রুটি বার্তাগুলির জন্য, সমস্যা সমাধান SSO দেখুন:

  • আপনার কী তৈরি করুন -- আপনার পরিচয় প্রদানকারীর সাহায্যে, DSA অথবা RSA অ্যালগরিদম ব্যবহার করে পাবলিক এবং প্রাইভেট কীগুলির একটি সেট তৈরি করুন। পাবলিক কীটি একটি X.509 ফর্ম্যাট করা সার্টিফিকেটে রয়েছে। SAML-ভিত্তিক সিঙ্গেল সাইন-অন সাইনিং কী সম্পর্কে আরও তথ্যের জন্য, Google Workspace সিঙ্গেল সাইন-অন পরিষেবার জন্য জেনারেটিং কী এবং সার্টিফিকেট দেখুন।
  • গুগলে নিবন্ধন করুন -- গুগলে আপনার পাবলিক কী সার্টিফিকেট নিবন্ধন করতে অ্যাডমিন সেটিংস API এর একক সাইন-অন সেটিংস ব্যবহার করুন।
  • আপনার SSO সেটিংস সেট আপ করুন -- ডোমেনের পরিচয় প্রদানকারীর সার্ভারের সাথে যোগাযোগের জন্য ব্যবহৃত সেটিংস কনফিগার করতে অ্যাডমিন সেটিংস API এর একক সাইন-অন সেটিংস ব্যবহার করুন।

গেটওয়ে এবং রাউটিং সেটিংস

এই ফিডটি ডোমেন প্রশাসকদের তাদের ডোমেনের জন্য ইমেলের রাউটিং নিয়ন্ত্রণ করতে দেয়।

ইমেল রাউটিং অপারেশনগুলি অ্যাডমিনিস্ট্রেটরদের ডোমেন-স্তরের ইমেল রাউটিং সেটিংস নির্দিষ্ট করার অনুমতি দেয়। এটি অ্যাডমিন কনসোলের জিমেইল সেটিংসের ইমেল রাউটিং কার্যকারিতার অনুরূপ। আরও তথ্যের জন্য, ইমেল রাউটিং এবং ইমেল রাউটিং বৈশিষ্ট্যের দ্বৈত বিতরণ কনফিগারেশন দেখুন।

একটি অ্যাডমিন সেটিংস API XML অনুরোধ এবং প্রতিক্রিয়ার নমুনা

এই ডকুমেন্টটি raw XML এবং HTTP ব্যবহার করে মৌলিক অ্যাডমিন সেটিংস API অনুরোধ এবং প্রতিক্রিয়ার কোড উদাহরণ প্রদান করে। এই ডোমেন ডিফল্ট ভাষার উদাহরণটি একটি অনুরোধ এবং প্রতিক্রিয়া এন্ট্রির মূল অংশের জন্য সম্পূর্ণ XML এবং HTTP সিনট্যাক্স দেখায় যা প্রতিটি ক্রিয়াকলাপের জন্য সাধারণ:

ডোমেনের আউটবাউন্ড ইমেল গেটওয়ে সেটিং পরিবর্তন করতে, গেটওয়ে ফিড URL-এ একটি HTTP PUT পাঠান:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

ডোমেনের ডিফল্ট ভাষা PUT অনুরোধ AtomPub entry XML হল:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

অপারেশন-নির্দিষ্ট বৈশিষ্ট্য এবং মান ব্যতীত, atom:property উপাদানগুলি একটি একক কী-মান জোড়া প্রতিনিধিত্ব করে যাতে আপনি যে সম্পত্তি পুনরুদ্ধার বা আপডেট করতে চান সে সম্পর্কে তথ্য থাকে। এগুলি সমস্ত অ্যাডমিন সেটিংস API অনুরোধ সংস্থার জন্য সাধারণ।

ডোমেন ডিফল্ট ল্যাঙ্গুয়েজ রেসপন্স entry এলিমেন্টটি smartHost এবং smtpMode প্রোপার্টিগুলি, সেইসাথে XML সিনট্যাক্স প্রদান করে যা সমস্ত অ্যাডমিন সেটিংস API রেসপন্স বডিতে সাধারণ:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

একক সাইন-অন সেটিংস পরিচালনা করা

গুগল ওয়ার্কস্পেস সিঙ্গেল সাইন-অন ফিচার (SSO) ব্যবহারকারীদের একাধিক পরিষেবায় লগ ইন করতে দেয়, তবে কেবল একবার লগইন এবং পাসওয়ার্ড প্রবেশ করতে হয়। এই পাসওয়ার্ডটি ডোমেনের পরিচয় প্রদানকারী দ্বারা সংরক্ষণ করা হয়, গুগল ওয়ার্কস্পেস দ্বারা নয়। আরও তথ্যের জন্য, সহায়তা কেন্দ্রের SSO পৃষ্ঠাটি দেখুন। নিম্নলিখিত বিভাগগুলি সিঙ্গেল সাইন-অন সেটিংসের জন্য ব্যবহৃত XML ফর্ম্যাটটি প্রদর্শন করে।

একক সাইন-অন সেটিংস পুনরুদ্ধার করা হচ্ছে

একক সাইন-অন সেটিংস পুনরুদ্ধার করতে, SSO সাধারণ ফিড URL-এ একটি HTTP GET পাঠান এবং Authenticating to the Admin Settings পরিষেবাতে বর্ণিত একটি Authorization হেডার অন্তর্ভুক্ত করুন। এবং, ত্রুটি বার্তাগুলির জন্য, Troubleshooting SSO দেখুন:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

এই অপারেশনের অনুরোধের বডিতে কোনও প্যারামিটার নেই।

একটি সফল প্রতিক্রিয়া একটি HTTP 200 OK স্ট্যাটাস কোড, ডোমেনের SSO সেটিংস সহ একটি AtomPub ফিড সহ ফেরত পাঠায়।

GET রেসপন্স XML samlSignonUri , samlLogoutUri , changePasswordUri , enableSSO , ssoWhitelist , এবং useDomainSpecificIssuer প্রোপার্টিগুলি ফেরত পাঠায়:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

বৈশিষ্ট্যগুলির মধ্যে রয়েছে:

samlSignonUri সম্পর্কে
পরিচয় প্রদানকারীর URL যেখানে Google Workspace ব্যবহারকারীর প্রমাণীকরণের জন্য SAML অনুরোধ পাঠায়।
samlLogoutUri সম্পর্কে
ওয়েব অ্যাপ্লিকেশন থেকে লগ আউট করার সময় ব্যবহারকারীদের যে ঠিকানায় পাঠানো হবে।
পাসওয়ার্ড পরিবর্তন করুনUri
ওয়েব অ্যাপ্লিকেশনের জন্য ব্যবহারকারীরা যখন তাদের SSO পাসওয়ার্ড পরিবর্তন করতে চান তখন যে ঠিকানায় তাদের পাঠানো হবে।
SSO সক্ষম করুন
এই ডোমেনের জন্য SAML-ভিত্তিক SSO সক্ষম করে। যদি আপনি পূর্বে SSO সেটিংস কনফিগার করে থাকেন এবং পরবর্তীতে enableSSO কে enableSSO=false এ সেট করে থাকেন, তাহলে আপনার পূর্বে প্রবেশ করা সেটিংস এখনও সংরক্ষিত থাকবে।
ssoWhitelist সম্পর্কে
ssoWhitelist হল ক্লাসলেস ইন্টার-ডোমেন রাউটিং (CIDR) ফর্ম্যাটে একটি নেটওয়ার্ক মাস্ক আইপি ঠিকানা। ssoWhitelist নির্ধারণ করে যে কোন ব্যবহারকারী SSO ব্যবহার করে লগ ইন করেন এবং কোন ব্যবহারকারী Google Workspace অ্যাকাউন্ট প্রমাণীকরণ পৃষ্ঠা ব্যবহার করে লগ ইন করেন। যদি কোনও মাস্ক নির্দিষ্ট না থাকে, তাহলে সমস্ত ব্যবহারকারী SSO ব্যবহার করে লগ ইন করবেন। আরও তথ্যের জন্য, নেটওয়ার্ক মাস্ক কীভাবে কাজ করে তা দেখুন।
ডোমেন স্পেসিফিক ইস্যুয়ার ব্যবহার করুন
পরিচয় প্রদানকারীর কাছে SAML অনুরোধে একটি ডোমেন নির্দিষ্ট ইস্যুকারী ব্যবহার করা যেতে পারে। যদিও বেশিরভাগ SSO স্থাপনার জন্য প্রয়োজনীয় নয়, এই বৈশিষ্ট্যটি বৃহৎ কোম্পানিগুলিতে কার্যকর যেখানে একাধিক সাবডোমেন সহ একটি সম্পূর্ণ প্রতিষ্ঠানকে প্রমাণীকরণ করার জন্য একটি একক পরিচয় প্রদানকারী ব্যবহার করা হয়। নির্দিষ্ট ডোমেন ইস্যুকারী প্রদানের মাধ্যমে কোন সাবডোমেনটি অনুরোধের সাথে যুক্ত করা হবে তা নির্ধারণ করা হয়। আরও তথ্যের জন্য, SAML অনুরোধে ইস্যুকারী উপাদান কীভাবে কাজ করে তা দেখুন?

যদি আপনার অনুরোধ কোনও কারণে ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত পাঠানো হবে। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

একক সাইন-অন সেটিংস আপডেট করা হচ্ছে

একটি ডোমেনের SSO সেটিংস আপডেট করতে, প্রথমে Retrieving Single Sign-On সেটিংস অপারেশন ব্যবহার করে SSO সেটিংস পুনরুদ্ধার করুন, এটি পরিবর্তন করুন এবং তারপর SSO ফিড URL-এ একটি PUT অনুরোধ পাঠান। নিশ্চিত করুন যে আপনার আপডেট করা এন্ট্রিতে <id> মানটি বিদ্যমান এন্ট্রির <id> এর সাথে হুবহু মেলে। Authenticating to the Admin Settings API পরিষেবাতে বর্ণিত একটি Authorization হেডার অন্তর্ভুক্ত করুন। এবং, ত্রুটি বার্তাগুলির জন্য, Troubleshooting SSO দেখুন।

একক সাইন-অন সেটিংস আপডেট করার সময়, SSO সাধারণ ফিড URL-এ একটি HTTP PUT পাঠান:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

PUT অনুরোধের XML বডি হল:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

একটি সফল প্রতিক্রিয়া একটি HTTP 200 OK স্ট্যাটাস কোড, SSO সেটিংস সহ একটি AtomPub ফিড সহ ফেরত পাঠায়।

PUT প্রতিক্রিয়া XML হল:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

যদি আপনার অনুরোধ কোনও কারণে ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত পাঠানো হবে। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

যখন লক্ষ্য গ্রাহক সংবেদনশীল ক্রিয়াকলাপের জন্য বহু-পক্ষীয় অনুমোদন সক্ষম করে তখন একক সাইন-অন সেটিংসে পরিবর্তনগুলি অনুমোদিত নয়। errorCode="1811" এবং reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" সহ অনুরোধগুলি ব্যর্থ হবে।

একক সাইন-অন সাইনিং কী পুনরুদ্ধার করা হচ্ছে

সিঙ্গেল সাইন-অন সাইনিং কী পুনরুদ্ধার করতে, SSO সাইনিং কী ফিড URL-এ একটি HTTP GET পাঠান এবং Authenticating to the Admin Settings পরিষেবাতে বর্ণিত একটি Authorization হেডার অন্তর্ভুক্ত করুন। এবং, ত্রুটি বার্তাগুলির জন্য, Troubleshooting SSO দেখুন:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

এই অপারেশনের অনুরোধের বডিতে কোনও প্যারামিটার নেই।

একটি সফল প্রতিক্রিয়া একটি HTTP 200 OK স্ট্যাটাস কোড, সাইনিং কী সহ একটি AtomPub ফিড সহ ফেরত পাঠায়।

GET রেসপন্স XML signingKey প্রোপার্টিটি ফেরত দেয়: 

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

যদি আপনার অনুরোধ কোনও কারণে ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত পাঠানো হবে। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

একক সাইন-অন সাইনিং কী আপডেট করা হচ্ছে

একটি ডোমেনের SSO সাইনিং কী আপডেট করতে, প্রথমে Retrieving Single Sign-On সাইনিং কী অপারেশন ব্যবহার করে সাইনিং কীটি পুনরুদ্ধার করুন, এটি পরিবর্তন করুন এবং তারপর SSO সাইনিং কী ফিড URL-এ একটি PUT অনুরোধ পাঠান। নিশ্চিত করুন যে আপনার আপডেট করা এন্ট্রিতে <id> মানটি বিদ্যমান এন্ট্রির <id> এর সাথে হুবহু মেলে। SAML-ভিত্তিক সিঙ্গেল সাইন-অন সাইনিং কী সম্পর্কে আরও তথ্যের জন্য, Google Workspace Single Sign-On পরিষেবার জন্য Generating Keys and Certificates দেখুন।

সিঙ্গেল সাইন-অন সাইনিং কী আপডেট করার সময়, SSO সাইনিং কী ফিড URL-এ একটি HTTP PUT পাঠান: 

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

PUT অনুরোধ XML হল: 

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

যখন লক্ষ্য গ্রাহক সংবেদনশীল ক্রিয়াকলাপের জন্য বহু-পক্ষীয় অনুমোদন সক্ষম করে তখন একক সাইন-অন সেটিংসে পরিবর্তনগুলি অনুমোদিত নয়। errorCode="1811" এবং reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" সহ অনুরোধগুলি ব্যর্থ হবে।

ইমেল গেটওয়ে এবং রাউটিং পরিচালনা করা

আউটবাউন্ড ইমেল গেটওয়ে বিভাগটি দেখায় যে কীভাবে অ্যাডমিন সেটিংস API আপনার ডোমেনের ব্যবহারকারীদের কাছ থেকে আসা মেলের আউটবাউন্ড রাউটিং সমর্থন করে। ইমেল রাউটিং বিভাগটি দেখায় যে কীভাবে অন্য মেল সার্ভারে বার্তাগুলি রুট করতে হয়।

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস পুনরুদ্ধার করা হচ্ছে

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস পুনরুদ্ধার করতে, গেটওয়ে ফিড URL-এ একটি HTTP GET পাঠান এবং Authenticating to the Admin Settings পরিষেবাতে বর্ণিত একটি Authorization হেডার অন্তর্ভুক্ত করুন: 

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

এই অপারেশনের অনুরোধের বডিতে কোনও প্যারামিটার নেই।

একটি সফল প্রতিক্রিয়া একটি HTTP 200 OK স্ট্যাটাস কোড, ইমেল গেটওয়ে স্ট্যাটাস তথ্য সহ একটি AtomPub ফিড সহ ফেরত পাঠায়।

GET রেসপন্সটি smartHost এবং smtpMode প্রোপার্টিগুলি ফেরত দেয়। এই প্রোপার্টিগুলি সম্পর্কে আরও তথ্যের জন্য, আউটবাউন্ড ইমেল গেটওয়ে সেটিংস আপডেট করা দেখুন।

সম্ভাব্য প্রতিক্রিয়ার একটি উদাহরণ হল: 

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

যদি আপনার অনুরোধ কোনও কারণে ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত পাঠানো হবে। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস আপডেট করা হচ্ছে

কোনও ডোমেনের আউটবাউন্ড ইমেল গেটওয়ে সেটিং আপডেট করতে, গেটওয়ে ফিড URL-এ একটি HTTP PUT অনুরোধ পাঠান: 

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

PUT অনুরোধ XML হল: 

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

অনুরোধের বৈশিষ্ট্যগুলি হল:

স্মার্টহোস্ট
আপনার SMTP সার্ভারের IP ঠিকানা অথবা হোস্টনেম। Google Workspace এই সার্ভারে আউটগোয়িং মেল রুট করে।
smtpMode সম্পর্কে
ডিফল্ট মান হল SMTP। আরেকটি মান, SMTP_TLS, বার্তা প্রদানের সময় TLS এর সাথে একটি সংযোগ সুরক্ষিত করে।

একটি সফল প্রতিক্রিয়া একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে, সাথে AtomPub ফিড এবং ইমেল গেটওয়ে সেটিংস স্ট্যাটাসও প্রদান করে।

যদি আপনার অনুরোধ কোনও কারণে ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত পাঠানো হবে। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

ইমেল রাউটিং সেটিংস পরিচালনা করা

প্রথমে, একটি XML অনুরোধ তৈরি করুন: 

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

অনুরোধের বৈশিষ্ট্যগুলি হল:

রুটগন্তব্য
এই গন্তব্যস্থল হল SMTP-In মেইল ​​সার্ভারের হোস্টনেম বা IP ঠিকানা যেখানে ইমেলটি রাউট করা হচ্ছে। হোস্টনেম বা IP ঠিকানাটি Google-এর জন্য সমাধান করতে হবে। মেল হোস্ট নেম সমাধান সম্পর্কে আরও তথ্যের জন্য, পাইলট Google Workspace ইমেল রাউটিং সহ দেখুন।
রুটরিরাইটে
যদি সত্য হয়, তাহলে বার্তার SMTP এনভেলপ to: ক্ষেত্রটি গন্তব্য হোস্টনেমে (user@destination এর হোস্টনেম) পরিবর্তিত হবে এবং বার্তাটি গন্তব্য মেল সার্ভারের এই ব্যবহারকারীর ঠিকানায় পৌঁছে যাবে। যদি false , তাহলে ইমেলটি গন্তব্য মেল সার্ভারের মূল বার্তার to: ইমেল ঠিকানায় (user@original hostname) পৌঁছে যাবে। এটি অ্যাডমিন কনসোলের 'SMTP এনভেলপ পরিবর্তন করুন' সেটিং এর অনুরূপ। আরও তথ্যের জন্য, ইমেল রাউটিংয়ের জন্য ডোমেন সেটিংস দেখুন।
রুট সক্ষম করা হয়েছে
যদি true , তাহলে ইমেল রাউটিং কার্যকারিতা সক্রিয় করা হয়। যদি false , তাহলে কার্যকারিতা অক্ষম করা হয়।
বাউন্সনোটিফিকেশন
যদি true , তাহলে ডেলিভারি ব্যর্থ হলে প্রেরককে বাউন্স বিজ্ঞপ্তি পাঠানোর জন্য Google Workspace সক্ষম করা আছে।
অ্যাকাউন্ট হ্যান্ডলিং

এই সেটিংটি নির্ধারণ করে যে ডোমেনের বিভিন্ন ধরণের ব্যবহারকারীরা ইমেল রাউটিং দ্বারা কীভাবে প্রভাবিত হয়:

  • allAccounts -- এই গন্তব্যে সমস্ত ইমেল পৌঁছে দিন।
  • provisionedAccounts -- ব্যবহারকারী যদি Google Workspace-এ থাকেন, তাহলে এই গন্তব্যে মেল পৌঁছে দিন।
  • unknownAccounts -- যদি ব্যবহারকারী Google Workspace-এ না থাকে, তাহলে এই গন্তব্যে মেল ডেলিভারি করুন। এটি অ্যাডমিন কনসোলের 'ডেলিভারি ইমেল ফর' সেটিং-এর অনুরূপ। পূর্বশর্ত এবং মেল রাউটিং কীভাবে ব্যবহার করবেন সে সম্পর্কে আরও তথ্যের জন্য, ইমেল রাউটিংয়ের জন্য ডোমেন সেটিংস দেখুন। ~ এই অনুরোধটি প্রকাশ করতে, ইমেল রাউটিং ফিড URL-এ একটি HTTP POST পাঠান এবং অ্যাডমিন সেটিংস পরিষেবার প্রমাণীকরণে বর্ণিত একটি Authorization শিরোনাম অন্তর্ভুক্ত করুন:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

একটি সফল প্রতিক্রিয়া একটি HTTP 200 OK স্ট্যাটাস কোড, আর্কাইভ তথ্য সহ একটি AtomPub ফিড সহ ফেরত পাঠায়।

যদি আপনার অনুরোধ কোনও কারণে ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত পাঠানো হবে। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

৩১ অক্টোবর, ২০১৮ তারিখে শেষবিন্দু সূর্যাস্ত

এই ঘোষণার অংশ হিসেবে আমরা নিম্নলিখিত এন্ডপয়েন্টগুলিকে অবহেলা করেছি। এগুলি ৩১ অক্টোবর, ২০১৮ তারিখে অস্ত গেছে এবং আর উপলব্ধ নেই।

  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryইমেল
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/সংস্করণ
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx