Cloud Firestore REST API ব্যবহার করা

Cloud Firestore ব্যবহার করার সবচেয়ে সহজ উপায় হল, নেটিভ ক্লায়েন্ট লাইব্রেরির মধ্যে থেকে কোনও একটি ব্যবহার করা, তবে কিছু পরিস্থিতিতে সরাসরি REST API কল করাও উপযোগী হতে পারে।

REST API নিম্নলিখিত ক্ষেত্রে সহায়ক হতে পারে:

  • ইন্টারনেট অফ থিংস (IoT) ডিভাইসের মতো রিসোর্স-সীমাবদ্ধ পরিবেশ থেকে Cloud Firestore অ্যাক্সেস করা, যেখানে সম্পূর্ণ ক্লায়েন্ট লাইব্রেরি চালানো সম্ভব নয়।
  • ডেটাবেস অ্যাডমিনিস্ট্রেশন অটোমেট করা বা বিস্তারিত ডেটাবেস মেটাডেটা ফিরিয়ে আনা।

আপনি যদি gRPC-সমর্থিত ভাষা ব্যবহার করেন, তাহলে REST API-এর পরিবর্তে RPC API ব্যবহার করার কথা বিবেচনা করুন।

যাচাইকরণ ও অনুমোদন

যাচাইকরণের জন্য, Cloud Firestore REST API হয় একটি Firebase Authentication আইডি টোকেন অথবা একটি Google Identity OAuth 2.0 টোকেন গ্রহণ করে। আপনার দেওয়া টোকেন অনুরোধের অনুমোদনে প্রভাব ফেলে:

  • আপনার অ্যাপ্লিকেশনের ব্যবহারকারীদের থেকে আসা অনুরোধ যাচাই করতে Firebase আইডি টোকেন ব্যবহার করুন। এইসব অনুরোধের জন্য, কোনও অনুরোধ অনুমোদিত কিনা তা নির্ধারণ করতে Cloud Firestore Cloud Firestore Security Rules ব্যবহার করে।

  • আপনার অ্যাপ্লিকেশন থেকে আসা অনুরোধ যাচাই করতে, Google Identity OAuth 2.0 টোকেন এবং একটি পরিষেবা অ্যাকাউন্ট ব্যবহার করুন, যেমন ডেটাবেস অ্যাডমিনিস্ট্রেশনের জন্য অনুরোধ। এইসব অনুরোধের ক্ষেত্রে, Cloud Firestore পরিচয় ও অ্যাক্সেস ম্যানেজমেন্ট (IAM) ব্যবহার করে নির্ধারণ করে যে কোনও অনুরোধ অনুমোদিত কিনা।

Firebase আইডি টোকেন ব্যবহার করা

আপনি দুটি উপায়ে Firebase আইডি টোকেন পেতে পারেন:

ব্যবহারকারীর Firebase আইডি টোকেন ফিরিয়ে আনার মাধ্যমে, আপনি ব্যবহারকারীর হয়ে অনুরোধ করতে পারবেন।

Firebase আইডি টোকেন দিয়ে যাচাই করা অনুরোধ এবং যাচাই না করা অনুরোধের ক্ষেত্রে, অনুরোধ অনুমোদিত কিনা তা নির্ধারণ করতে Cloud Firestore আপনার Cloud Firestore Security Rules ব্যবহার করে।

Google Identity OAuth 2.0 টোকেন ব্যবহার করা

আপনি Google API ক্লায়েন্ট লাইব্রেরি সহ পরিষেবা অ্যাকাউন্ট ব্যবহার করে অথবা সার্ভার থেকে সার্ভার অ্যাপ্লিকেশনের জন্য OAuth 2.0 ব্যবহার করা লিঙ্কে উল্লেখ করা ধাপগুলি অনুসরণ করে অ্যাক্সেস টোকেন জেনারেট করতে পারবেন। এছাড়াও, আপনি gcloud কমান্ড-লাইন টুল ও gcloud auth application-default print-access-token কমান্ডের সাহায্যে টোকেন জেনারেট করতে পারবেন।

Cloud Firestore REST API-তে অনুরোধ পাঠাতে এই টোকেনের নিম্নলিখিত স্কোপ থাকতে হবে:

  • https://www.googleapis.com/auth/datastore

আপনি যদি কোনও পরিষেবা অ্যাকাউন্ট এবং Google Identity OAuth 2.0 টোকেন দিয়ে আপনার অনুরোধ যাচাই করেন, তাহলে Cloud Firestore ধরে নেয় যে আপনার অনুরোধগুলি কোনও স্বতন্ত্র ব্যবহারকারীর পরিবর্তে আপনার অ্যাপ্লিকেশনের পক্ষ থেকে কাজ করে। Cloud Firestore এইসব অনুরোধকে আপনার নিরাপত্তা সংক্রান্ত নিয়ম উপেক্ষা করার অনুমতি দেয়। পরিবর্তে, কোনও অনুরোধ অনুমোদিত কিনা তা নির্ধারণ করতে Cloud Firestore IAM ব্যবহার করে।

আপনি Cloud Firestore IAM ভূমিকা অ্যাসাইন করে পরিষেবা অ্যাকাউন্টের অ্যাক্সেস সংক্রান্ত অনুমতি নিয়ন্ত্রণ করতে পারবেন।

অ্যাক্সেস টোকেন দিয়ে যাচাই করা হচ্ছে

Firebase ID টোকেন বা Google Identity OAuth 2.0 টোকেন পাওয়ার পরে, এটি Cloud Firestore এন্ডপয়েন্টে Authorization হিসেবে পাস করুন যেখানে হেডার Bearer {YOUR_TOKEN} হিসেবে সেট করা আছে।

REST কল করা হচ্ছে

সব REST API এন্ডপয়েন্ট বেস URL https://firestore.googleapis.com/v1/-এর অধীনে থাকে।

YOUR_PROJECT_ID প্রোজেক্টের অধীনে cities সংগ্রহে LA আইডি সহ কোনও ডকুমেন্টের পাথ তৈরি করতে আপনাকে নিম্নলিখিত স্ট্রাকচার ব্যবহার করতে হবে।

/projects/YOUR_PROJECT_ID/databases/(default)/documents/cities/LA

এই পাথের সাথে ইন্টার‍্যাক্ট করতে, এটিকে বেস API URL-এর সাথে একত্রিত করুন।

https://firestore.googleapis.com/v1/projects/YOUR_PROJECT_ID/databases/(default)/documents/cities/LA

REST API নিয়ে এক্সপেরিমেন্ট শুরু করার সবচেয়ে ভালো উপায় হল API Explorer ব্যবহার করা, যা অটোমেটিক Google Identity OAuth 2.0 টোকেন তৈরি করে এবং আপনাকে API পরীক্ষা করার অনুমতি দেয়।

পদ্ধতি

নিচে দুটি সবচেয়ে গুরুত্বপূর্ণ পদ্ধতি গ্রুপের সংক্ষিপ্ত বিবরণ দেওয়া হল। সম্পূর্ণ তালিকার জন্য, REST API রেফারেন্স দেখুন অথবা API Explorer ব্যবহার করুন।

v1.projects.databases.documents

ডেটা যোগ করুন বা ডেটা পান গাইডে উল্লেখ করা CRUD অপারেশন ডকুমেন্টে পারফর্ম করুন।

v1.projects.databases.collectionGroups.indexes

ইনডেক্সে অ্যাকশন পারফর্ম করুন, যেমন নতুন ইনডেক্স তৈরি করা, আগে থেকে থাকা ইনডেক্স বন্ধ করা অথবা বর্তমান সব ইনডেক্সের তালিকা তৈরি করা। ডেটা স্ট্রাকচার মাইগ্রেশন অটোমেট করা বা প্রোজেক্টের মধ্যে ইনডেক্স সিঙ্ক করার জন্য উপযোগী।

এছাড়াও, এটি ডকুমেন্টের মেটাডেটা ফিরিয়ে আনার সুবিধা দেয়, যেমন কোনও নির্দিষ্ট ডকুমেন্টের জন্য সমস্ত ফিল্ড এবং সাবকালেকশনের তালিকা।

ত্রুটি কোড

Cloud Firestore অনুরোধ সফল হলে, Cloud Firestore API একটি HTTP 200 OK স্ট্যাটাস কোড এবং অনুরোধ করা ডেটা ফেরত দেয়। কোনও অনুরোধ ব্যর্থ হলে, Cloud Firestore API একটি HTTP 4xx বা 5xx স্ট্যাটাস কোড এবং সমস্যা সম্পর্কে তথ্য সহ একটি উত্তর ফেরত দেয়।

নিচের সারণীতে প্রতিটি ত্রুটি কোডের জন্য প্রস্তাবিত পদক্ষেপের তালিকা দেওয়া হয়েছে। এই কোডগুলি Cloud Firestore REST এবং RPC API-এর ক্ষেত্রে প্রযোজ্য। Cloud Firestore SDK ও ক্লায়েন্ট লাইব্রেরি একই ধরনের সমস্যার কোড নাও দেখাতে পারে।

ক্যানোনিকাল ত্রুটি কোড বিবরণ সাজেস্ট করা অ্যাকশন
ABORTED অনুরোধটি অন্য একটি অনুরোধের সাথে বিরোধপূর্ণ। ট্রানজ্যাকশন সংক্রান্ত নয় এমন কমিটের জন্য:
অনুরোধ আবার করুন অথবা কনটেনশন কমাতে আপনার ডেটা মডেল আবার স্ট্রাকচার করুন।

ট্রানজ্যাকশনে থাকা অনুরোধের জন্য:
সম্পূর্ণ ট্রানজ্যাকশন আবার করুন অথবা কনটেনশন কমাতে আপনার ডেটা মডেল আবার স্ট্রাকচার করুন।
ALREADY_EXISTS অনুরোধটি এমন একটি ডকুমেন্ট তৈরি করার চেষ্টা করেছে যা আগে থেকেই আছে। সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।
DEADLINE_EXCEEDED অনুরোধটি প্রসেস করার সময় Cloud Firestore সার্ভার সময়সীমা অতিক্রম করেছে। এক্সপোনেনশিয়াল ব্যাকঅফ ব্যবহার করে আবার চেষ্টা করুন।
FAILED_PRECONDITION অনুরোধটি তার পূর্বশর্তগুলির একটি পূরণ করেনি। যেমন, কোনও কোয়েরি অনুরোধের জন্য এমন একটি ইন্ডেক্স প্রয়োজন হতে পারে যা এখনও সংজ্ঞায়িত করা হয়নি। যে পূর্বশর্ত পূরণ করা যায়নি তার জন্য সমস্যার উত্তরে মেসেজ ফিল্ড দেখুন। সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।
INTERNAL Cloud Firestore সার্ভার থেকে একটি সমস্যা ফেরত পাঠানো হয়েছে। এই অনুরোধ একবারের বেশি আবার করার চেষ্টা করবেন না।
INVALID_ARGUMENT অনুরোধের প্যারামিটারে ভুল ভ্যালু আছে। ভুল ভ্যালুর জন্য সমস্যার উত্তরে মেসেজ ফিল্ড দেখুন। সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।
NOT_FOUND অনুরোধটি এমন একটি ডকুমেন্ট আপডেট করার চেষ্টা করেছে যা নেই। সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।
PERMISSION_DENIED এই অনুরোধ করার জন্য ব্যবহারকারীর কাছে অনুমতি নেই। সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।
RESOURCE_EXHAUSTED প্রোজেক্টটি হয় তার কোটা অথবা অঞ্চল/মাল্টি-রিজিয়ন ক্যাপাসিটি অতিক্রম করেছে। আপনার প্রোজেক্ট কোটা পেরিয়ে যাননি তা যাচাই করুন। আপনি যদি কোনও প্রোজেক্ট কোটা অতিক্রম করে থাকেন, তাহলে সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।

অন্যথায়, এক্সপোনেনশিয়াল ব্যাকঅফ সহ আবার চেষ্টা করুন।
UNAUTHENTICATED অনুরোধে সঠিক যাচাইকরণ সংক্রান্ত ক্রেডেনশিয়াল অন্তর্ভুক্ত করা হয়নি। সমস্যার সমাধান না করে আবার চেষ্টা করবেন না।
UNAVAILABLE Cloud Firestore সার্ভার থেকে একটি সমস্যা ফেরত পাঠানো হয়েছে। এক্সপোনেনশিয়াল ব্যাকঅফ ব্যবহার করে আবার চেষ্টা করুন।