আপনার API প্রকাশ করা

UI

API ক্যাটালগ দেখতে:

1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
2. পোর্টালের হোম পেজে API ক্যাটালগ বিকল্পে ক্লিক করুন। অথবা, আপনি উপরের নেভিগেশন বারে পোর্টাল ড্রপ-ডাউন মেনু থেকে API ক্যাটালগ বেছে নিতে পারেন।

API ক্যাটালগে API ট্যাব আপনার পোর্টালে যোগ করা হয়েছে এমন API-এর একটি তালিকা দেখায়।

আগের ছবিতে হাইলাইট করা অংশ অনুযায়ী, API ট্যাব আপনাকে এগুলি করতে দেয়:

• আপনার পোর্টালের উপলভ্য API-এর বিবরণ দেখুন
• আপনার পোর্টালে API যোগ করুন
• নিম্নলিখিত টাস্কের মধ্যে একটি বা একাধিক টাস্ক সম্পূর্ণ করে আপনার পোর্টালের কোনও API এডিট করুন:
  • API রেফারেন্স ডকুমেন্টেশন আপডেট করতে, API প্রোডাক্টের সাথে যুক্ত ডকুমেন্টের স্ন্যাপশট ম্যানেজ করুন
  • আপনার পোর্টালে কোনও API প্রকাশ বা আনপাবলিশ করা
  • আপনার পোর্টালের API-এর ভিজিবিলিটি ম্যানেজ করা:
  • কোনও API-এর জন্য কলব্যাক URL ম্যানেজ করা
  • API কার্ডের জন্য ছবি ম্যানেজ করা
  • বিভাগ ব্যবহার করে API ট্যাগ করা
  • API-এর নাম ও বিবরণ এডিট করুন
• আপনার পোর্টাল থেকে কোনও API সরিয়ে দেওয়া
• সম্পর্কিত API খুঁজে পাওয়ার জন্য ব্যবহৃত বিভাগ ম্যানেজ করা
• স্পেক স্টোর থেকে সরিয়ে দেওয়া হয়েছে বা মেয়াদ শেষ হয়ে গেছে এমন স্পেসিফিকেশন দ্রুত শনাক্ত করা
• দ্রুত অনাথ API শনাক্ত করুন, যেগুলির সংশ্লিষ্ট API প্রোডাক্ট Apigee Edge থেকে সরিয়ে দেওয়া হয়েছে এবং API প্রোডাক্টটি আবার তৈরি করুন অথবা আপনার পোর্টাল থেকে API মুছে দিন

কার্ল

API তালিকাভুক্ত করতে:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।

উত্তর পেলোডের মধ্যে পৃষ্ঠাঙ্কন ব্যবহার করার নির্দেশাবলীর জন্য পৃষ্ঠাঙ্কন নোট দেখুন ।

উত্তরের পেলোড:

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

যেখানে:

• modified: Epoch থেকে মিলিসেকেন্ডে ক্যাটালগ আইটেম শেষবার পরিবর্তন করার সময়। যেমন, 1698165480000
• id: ক্যাটালগ আইটেমের আইডি। যেমন, 399668

পেজিনেশন সংক্রান্ত নোট:

• পৃষ্ঠার সাইজ: একটি পৃষ্ঠায় রিটার্ন করার জন্য আইটেমের সংখ্যা নির্দিষ্ট করতে pageSize ব্যবহার করুন । ডিফল্ট মান হল ২৫ এবং সর্বাধিক মান হল ১০০। আরও পৃষ্ঠা থাকলে, nextPageToken-এ একটি টোকেন যোগ করা হয়:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
     -H "Authorization: Bearer ACCESS_TOKEN"
  

  পরিবর্তন করুন:

  • PAGE_SIZE সহ একটি পৃষ্ঠায় রিটার্ন করার জন্য তালিকা আইটেমের সংখ্যা। যেমন, ১০।

  উত্তরের পেলোড:

  {
    "status": "success",
    "message": "one page of apidocs returned",
    "data": [
      {
        "id": 638007,
        "siteId": "tsnow-mint-liztest",
        "title": "Testing",
        "description": "",
        "published": false,
        "visibility": false,
        "apiId": "testcatalog",
        "apiProductName": "testcatalog",
        "edgeAPIProductName": "testcatalog",
        "specId": "Petstore",
        "specContent": null,
        "specTitle": null,
        "snapshotExists": true,
        "snapshotModified": 1726508367000,
        "modified": 1728582504000,
        "anonAllowed": false,
        "imageUrl": null,
        "snapshotState": "OK_SUBMITTED",
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": "YAML",
        "specModified": null,
        "snapshotOutdated": false,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      }
    ],
    "code": null,
    "request_id": "1068810934",
    "error_code": null,
    "next_page_token": ""
  }
  

• পৃষ্ঠার টোকেন: একাধিক পৃষ্ঠা থাকলে, পরবর্তী পৃষ্ঠাগুলি পেতে pageToken ব্যবহার করুন:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
        -H "Authorization: Bearer ACCESS_TOKEN"
  

  পরিবর্তন করুন:

  • PAGE_SIZE সহ একটি পৃষ্ঠায় রিটার্ন করার জন্য তালিকা আইটেমের সংখ্যা। যেমন, ১০।
  • nextPageToken ভ্যালু সহ PAGE_TOKEN। যেমন, 7zcqrin9l6xhi4nbrb9.

UI

আপনার পোর্টালে API যোগ করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।

3. + যোগ করুন বিকল্পে ক্লিক করুন।

   ক্যাটালগে API প্রোডাক্ট যোগ করুন ডায়ালগ দেখা যাবে।

4. আপনার পোর্টালের সাথে যে API প্রোডাক্ট যোগ করতে চান সেটি বেছে নিন।

5. পরবর্তী বিকল্পে ক্লিক করুন। API-এর বিবরণ পৃষ্ঠাটি দেখানো হয়।

6. API রেফারেন্স ডকুমেন্টেশনের কন্টেন্ট ও পোর্টালে এর দৃশ্যমানতা কনফিগার করুন:

   ফিল্ড	বিবরণ
   প্রকাশিত	আপনার পোর্টাল API প্রকাশ করতে প্রকাশিত বিকল্প বেছে নিন। আপনি API প্রকাশ করার জন্য প্রস্তুত না হলে, চেকবক্স থেকে টিকচিহ্ন সরিয়ে দিন। আপনি পরে সেটিং পরিবর্তন করতে পারবেন, যেমনটি আপনার পোর্টাল থেকে কোনও API প্রকাশ বা আনপাবলিশ করুন নিবন্ধে বর্ণনা করা হয়েছে।
   দেখানোর জন্য শীর্ষক	ক্যাটালগে দেখানো API-এর নাম আপডেট করুন। ডিফল্ট হিসেবে, API প্রোডাক্টের নাম ব্যবহার করা হয়। আপনি পরে ডিসপ্লে শীর্ষক পরিবর্তন করতে পারবেন, যেমনটি ডিসপ্লে শীর্ষক ও বিবরণ এডিট করুন নিবন্ধে বর্ণনা করা হয়েছে।
   বিবরণ দেখানো	ক্যাটালগে দেখানো আপনার API-এর বিবরণ আপডেট করুন। ডিফল্ট হিসেবে, API প্রোডাক্টের বিবরণ ব্যবহার করা হয়। আপনি পরে ডিসপ্লে বিবরণ পরিবর্তন করতে পারবেন, যেমনটি ডিসপ্লে শীর্ষক ও বিবরণ এডিট করুন নিবন্ধে বর্ণনা করা হয়েছে।
   ডেভেলপারদের কলব্যাক URL নির্দিষ্ট করতে হবে	অ্যাপ ডেভেলপারদের একটি কলব্যাক URL উল্লেখ করতে বাধ্য করতে চাইলে এটি চালু করুন। আপনি পরে কলব্যাক URL যোগ করতে বা আপডেট করতে পারবেন, যেমনটি কোনও API-এর জন্য কলব্যাক URL ম্যানেজ করুন নিবন্ধে বর্ণনা করা হয়েছে।
   API ডকুমেন্টেশান	OpenAPI ডকুমেন্ট ব্যবহার করতে: OpenAPI ডকুমেন্ট বেছে নিন। ডকুমেন্ট বেছে নিন বিকল্পে ক্লিক করুন। নিম্নলিখিত ধাপগুলির মধ্যে কোনও একটি অনুসরণ করুন: আমার স্পেক ট্যাবে ক্লিক করুন এবং স্পেক স্টোর থেকে একটি স্পেক বেছে নিন। ফাইল আপলোড করুন ট্যাবে ক্লিক করে একটি ফাইল আপলোড করুন। URL থেকে ইমপোর্ট করুন ট্যাবে ক্লিক করে URL থেকে স্পেক ইমপোর্ট করুন। বেছে নিন বিকল্পে ক্লিক করুন। GraphQL স্কিমা ব্যবহার করতে: GraphQL স্কিমা বেছে নিন। ডকুমেন্ট বেছে নিন বিকল্পে ক্লিক করুন। GraphQL স্কিমায় নেভিগেট করে সেটি বেছে নিন। বেছে নিন বিকল্পে ক্লিক করুন। অথবা, আপনি কোনও ডকুমেন্টেশন নেই বিকল্প বেছে নিতে পারেন এবং API যোগ করার পরে ডকুমেন্টের স্ন্যাপশট ম্যানেজ করা নিবন্ধে যেমন বর্ণনা করা হয়েছে, তেমন একটি যোগ করতে পারেন।
   API দৃশ্যমানতা	আপনি যদি দর্শক ম্যানেজমেন্ট ফিচারের বিটা রিলিজে এনরোল না করে থাকেন, তাহলে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন: পরিচয় গোপনকারী ব্যবহারকারী যাতে সব ব্যবহারকারী এপিআই দেখতে পান। শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের API দেখতে দেওয়ার জন্য রেজিস্টার করা ব্যবহারকারী। আপনি যদি দর্শক ম্যানেজমেন্ট ফিচারের বিটা রিলিজে এনরোল করে থাকেন, তাহলে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন: সব ব্যবহারকারীকে API দেখার অনুমতি দিতে সর্বজনীন (যেকোনও ব্যক্তি দেখতে পাবেন) বিকল্প বেছে নিন। শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের API দেখার অনুমতি দিতে যাচাই করা ব্যবহারকারী। বেছে নেওয়া দর্শক বিকল্প থেকে সেইসব নির্দিষ্ট দর্শককে বেছে নিন যাদের আপনি API দেখতে দিতে চান। আপনি পরে অডিয়েন্সের দৃশ্যমানতা ম্যানেজ করতে পারবেন, যেমনটি আপনার পোর্টালের API-এর দৃশ্যমানতা ম্যানেজ করুন নিবন্ধে বর্ণনা করা হয়েছে।
   ডিসপ্লে ছবি	API পৃষ্ঠায় API কার্ডে ছবি দেখাতে, ছবি বেছে নিন বিকল্পে ক্লিক করুন। ছবি বেছে নিন ডায়ালগে, আগে থেকে থাকা ছবি বেছে নিন, নতুন ছবি আপলোড করুন অথবা এক্সটার্নাল ছবির URL প্রদান করে বেছে নিন বিকল্পে ক্লিক করুন। API থাম্বনেলের প্রিভিউ দেখুন এবং বেছে নিন বিকল্পে ক্লিক করুন। আপনি পরে ছবি যোগ করতে পারবেন, যেমনটি API কার্ডের জন্য ছবি ম্যানেজ করুন নিবন্ধে বর্ণনা করা হয়েছে। এক্সটার্নাল URL সহ কোনও ছবি নির্দিষ্ট করার সময়, ছবিটি আপনার অ্যাসেটে আপলোড করা হবে না; এছাড়াও, ইন্টিগ্রেটেড পোর্টালে ছবি লোড করা তার উপলভ্যতার উপর নির্ভর করবে, যা কন্টেন্ট নিরাপত্তা নীতি দ্বারা ব্লক বা সীমাবদ্ধ করা হতে পারে।
   বিভাগ	API-কে ট্যাগ করা হবে এমন বিভাগগুলি যোগ করুন যাতে অ্যাপ ডেভেলপাররা API পৃষ্ঠায় সম্পর্কিত API খুঁজে পেতে পারেন। বিভাগ শনাক্ত করতে: ড্রপডাউন তালিকা থেকে একটি বিভাগ বেছে নিন। নাম লিখে Enter টিপে নতুন বিভাগ যোগ করুন। নতুন বিভাগটি 'বিভাগ' পৃষ্ঠায় যোগ করা হবে এবং অন্যান্য API যোগ বা এডিট করার সময় উপলভ্য হবে।

7. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

আপনার পোর্টালে API যোগ করতে :

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।
• TITLE সহ ডিসপ্লে টাইটেল। যেমন, Hello World 2
• DESCRIPTION-এর ডিসপ্লে বিবরণ সহ। যেমন, Simple hello world example.
• true বা false (ডিফল্ট) সহ ANON_TRUE_OR_FALSE, যেখানে true বলতে বোঝায় এই API সর্বজনীনভাবে দৃশ্যমান এবং এটি পরিচয় গোপন রেখে দেখা যাবে; অন্যথায়, শুধুমাত্র রেজিস্টার করা ব্যবহারকারীরাই এটি দেখতে পাবেন।
• IMAGE_URL ক্যাটালগ আইটেমের জন্য ব্যবহৃত এক্সটার্নাল ছবির URL অথবা পোর্টালে সেভ করা ছবির ফাইলের ফাইল পাথ, যেমন, /files/book-tree.jpg। কোনও এক্সটার্নাল ছবির URL নির্দিষ্ট করার সময়, আপনার অ্যাসেটে ছবিটি আপলোড করা হবে না; এছাড়াও, ইন্টিগ্রেটেড পোর্টালে ছবিটি লোড করা তার উপলভ্যতার উপর নির্ভর করবে, যা কন্টেন্ট নিরাপত্তা নীতি দ্বারা ব্লক বা সীমাবদ্ধ করা হতে পারে।
• CALLBACK_TRUE_OR_FALSE সহ true অথবা false (ডিফল্ট), যেখানে true-এর জন্য অ্যাপ ম্যানেজ করার সময় পোর্টাল ব্যবহারকারীকে URL ইনপুট করতে হয়।
• CATEGORY_ID, ক্যাটেগরির আইডি সহ। যেমন, bf6505eb-2a0f-47af-a00a-ded40ac72960. একাধিক বিভাগ আইডি কমা দিয়ে আলাদা করুন। list API categories কমান্ডের মাধ্যমে বিভাগ আইডি পান।
• PUBLISHED_TRUE_OR_FALSE সহ true অথবা false (ডিফল্ট), যেখানে true থেকে বোঝা যায় যে API সর্বজনীনভাবে উপলভ্য। প্রকাশ করার পরে, আপনি সব ব্যবহারকারী, যাচাই করা ব্যবহারকারী বা নির্দিষ্ট ব্যবহারকারীদের অ্যাক্সেস দিতে পারবেন।
• API_PRODUCT API প্রোডাক্টের নাম সহ। যেমন, Hello World 2.

উত্তরের পেলোড:

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

যেখানে:

• modified: Epoch থেকে মিলিসেকেন্ডে ক্যাটালগ আইটেম শেষবার পরিবর্তন করার সময়। যেমন, 1698165480000
• id: ক্যাটালগ আইটেমের আইডি। যেমন, 399668

UI

API এডিট করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।
5. API বিবরণ বিকল্পের অধীনে, যেকোনও পরিবর্তন করুন। API যোগ করুন বিকল্পে উপলভ্য বিকল্পগুলির বিবরণ দেখুন।
6. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

API যোগ করার পরে, এডিট করতে update কল ব্যবহার করুন।

এই উদাহরণে, আপনার পোর্টালে API-এর প্রকাশিত স্ট্যাটাস true থেকে false-এ পরিবর্তন করার জন্য প্রয়োজনীয় ধাপগুলি দেখানো হয়েছে। প্রয়োজন হলে, একটি API কলে একাধিক সেটিং পরিবর্তন করতে পারবেন।

1. তৈরি করা id খুঁজে পেতে যা প্রতিটি API-কে অনন্যভাবে শনাক্ত করে, আপনার পোর্টালের API-এর একটি তালিকা পান যা API এক্সপ্লোর করুন লিঙ্কে বর্ণনা করা হয়েছে।

2. নির্দিষ্ট API-এর বর্তমান ভ্যালু ফিরিয়ে দেয়:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
   -H "Authorization: Bearer ACCESS_TOKEN"
   

   নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

   • ORG_NAME সহ সংস্থার নাম। যেমন, my-org
   • SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
   • API_DOC সহ ডকুমেন্টের জেনারেট করা id। যেমন, 399668. এই ভ্যালু খুঁজে পেতে list API docs কমান্ড ব্যবহার করুন।
   • ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।

   উত্তরের পেলোড:

   {
     "status": "success",
     "message": "apidoc returned",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": false,
       "visibility": false,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729635493000,
       "anonAllowed": false,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": false,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "601210268",
     "error_code": null
   }
   

1. আপনি যে পরিবর্তনযোগ্য ভ্যালু রাখতে চান সেটি আপডেট কলে যোগ করুন এবং যে ভ্যালু পরিবর্তন করতে চান সেটি পরিবর্তন করুন। আপনি কোনও লাইন বাদ দিলে, ডিফল্ট সেটিং ব্যবহার করা হয়। এই উদাহরণের জন্য, প্রকাশিত সেটিং false থেকে true-এ পরিবর্তন করুন:

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "anonAllowed": true,
       "published": true
    }'
   

   নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

   • TITLE সহ ডিসপ্লে টাইটেল। যেমন, Hello World 2

   উত্তরের পেলোড:

   {
     "status": "success",
     "message": "ApiDoc updated",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": true,
       "visibility": true,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729989250000,
       "anonAllowed": true,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": null,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "738172002",
     "error_code": null
   }
   

UI

আপনার পোর্টাল থেকে কোনও API প্রকাশ করতে বা প্রকাশ করার তালিকা থেকে সরিয়ে দিতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।
5. API বিবরণ বিকল্পের মধ্যে, আপনার পোর্টালে API প্রকাশ বা প্রকাশ করা বন্ধ করতে, যথাক্রমে প্রকাশিত (ক্যাটালগে তালিকাভুক্ত) বিকল্প বেছে নিন বা সরিয়ে দিন।
6. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

আপডেট কলের মধ্যে নিম্নলিখিত বিষয়গুলির মধ্যে একটি অন্তর্ভুক্ত করুন:

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

API এডিট করতে:

1. বর্তমান ভ্যালু রিটার্ন করো:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
   -H "Authorization: Bearer ACCESS_TOKEN"

2. API এডিট করতে আপডেট কল ব্যবহার করুন। আপনি যে পরিবর্তনযোগ্য মান রাখতে ও পরিবর্তন করতে চান সেগুলি যোগ করুন এবং যে মান পরিবর্তন করতে চান সেগুলি পরিবর্তন করুন। আপনি পরিবর্তনযোগ্য কোনও সেটিং বাদ দিলে, সেটি ডিফল্ট ভ্যালু দিয়ে ওভাররাইট করা হয়।

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": IMAGE_URL,
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
        "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE
   }

প্রত্যাবর্তন করা ধাপ, ভেরিয়েবল ও পেলোডের বিস্তারিত উদাহরণের জন্য ডকুমেন্টের ভার্সন ম্যানেজ করুন লিঙ্ক দেখুন।

UI

আপনার পোর্টালের কোনও API-এর দৃশ্যমানতা ম্যানেজ করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।

5. দৃশ্যমানতা সেটিং বেছে নিন। আপনি যদি অডিয়েন্স ফিচারের বিটা রিলিজের জন্য এনরোল করে থাকেন, তাহলে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন:

   • সব ব্যবহারকারীকে পৃষ্ঠাটি দেখার অনুমতি দিতে সর্বজনীন (যেকেউ দেখতে পাবেন) বিকল্প বেছে নিন।
   • শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের পৃষ্ঠা দেখার অনুমতি দিতে যাচাই করা ব্যবহারকারী।
   • বেছে নেওয়া দর্শক বিকল্প থেকে সেইসব নির্দিষ্ট দর্শক বেছে নিন যারা এই পৃষ্ঠা দেখতে পাবেন। দেখুন আপনার পোর্টালের জন্য দর্শক ম্যানেজ করুন।
   অন্যথায়, নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন:
   • পরিচয় গোপনকারী ব্যবহারকারী যাতে সব ব্যবহারকারী পৃষ্ঠাটি দেখতে পান।
   • শুধুমাত্র রেজিস্টার করা ব্যবহারকারীদের পৃষ্ঠাটি দেখার অনুমতি দিতে রেজিস্টার করা ব্যবহারকারী।

6. জমা দিন বিকল্পে ক্লিক করুন।

কার্ল

আপনি যদি অডিয়েন্স ম্যানেজমেন্ট ফিচারের বিটা রিলিজে এনরোল করে থাকেন, তাহলে অডিয়েন্স ম্যানেজ করতে UI ব্যবহার করুন।

আপনি দর্শক ম্যানেজমেন্ট ফিচারে এনরোল না করে থাকলে, anonAllowed ব্যবহার করে দৃশ্যমানতা ম্যানেজ করা হয়।

update কলে এগুলির মধ্যে একটি যোগ করুন:

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

API এডিট করতে:

1. বর্তমান ভ্যালু রিটার্ন করো:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. API এডিট করতে আপডেট কল ব্যবহার করুন। আপনি যে পরিবর্তনযোগ্য ভ্যালু রাখতে চান সেগুলি যোগ করুন এবং যে ভ্যালু পরিবর্তন করতে চান সেগুলি পরিবর্তন করুন। আপনি পরিবর্তনযোগ্য সেটিং বাদ দিলে, ডিফল্ট ভ্যালু ব্যবহার করা হয়।

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ধাপ, ভেরিয়েবল এবং ফিরে আসা পেলোডের বিস্তারিত উদাহরণের জন্য API এডিট করুন দেখুন।

UI

কোনও API-এর জন্য কলব্যাক URL ম্যানেজ করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।
5. API বিবরণ বিকল্পের মধ্যে, ডেভেলপারদের কলব্যাক URL উল্লেখ করতে হবে চেকবক্সটি বেছে নিন বা টিকচিহ্ন সরিয়ে দিন।
6. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

update কলে এগুলির মধ্যে একটি যোগ করুন:

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

API এডিট করতে:

1. বর্তমান ভ্যালু রিটার্ন করো:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. API এডিট করতে আপডেট কল ব্যবহার করুন। আপনি যে পরিবর্তনযোগ্য ভ্যালু রাখতে চান সেগুলি যোগ করুন এবং যে ভ্যালু পরিবর্তন করতে চান সেগুলি পরিবর্তন করুন। আপনি পরিবর্তনযোগ্য সেটিং বাদ দিলে, ডিফল্ট ভ্যালু ব্যবহার করা হয়।

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ধাপ, ভেরিয়েবল এবং ফিরে আসা পেলোডের বিস্তারিত উদাহরণের জন্য API এডিট করুন দেখুন।

UI

API কার্ডের ছবি ম্যানেজ করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।

5. API বিবরণ-এর অধীনে:

   • কোনও ছবি বেছে নেওয়া না থাকলে, ছবি নির্দিষ্ট করতে বা আপলোড করতে ছবি বেছে নিন বিকল্পে ক্লিক করুন।
   • অন্য ছবি নির্দিষ্ট করতে বা আপলোড করতে ছবি পরিবর্তন করুন বিকল্পে ক্লিক করুন।
   • ছবিটি সরাতে, সেটির মধ্যে থাকা x আইকনে ক্লিক করুন।

   ছবি নির্দিষ্ট করার সময়, ক্যাটালগ আইটেমের জন্য ব্যবহৃত এক্সটার্নাল URL সহ ছবি অথবা পোর্টালে সেভ করা ছবি ফাইলের পাথ নির্দিষ্ট করুন, যেমন, /files/book-tree.jpg। কোনও এক্সটার্নাল ছবির URL উল্লেখ করার সময়, ছবিটি আপনার অ্যাসেটে আপলোড করা হবে না; এছাড়াও, ইন্টিগ্রেটেড পোর্টালে ছবি লোড করা সেটির উপলভ্যতার উপর নির্ভর করবে, যা কন্টেন্ট নিরাপত্তা নীতি দ্বারা ব্লক বা সীমাবদ্ধ করা হতে পারে।

6. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

update কলে এগুলি যোগ করুন:

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

API এডিট করতে:

1. বর্তমান ভ্যালু রিটার্ন করো:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. API এডিট করতে আপডেট কল ব্যবহার করুন। আপনি যে পরিবর্তনযোগ্য ভ্যালু রাখতে চান সেগুলি যোগ করুন এবং যে ভ্যালু পরিবর্তন করতে চান সেগুলি পরিবর্তন করুন। আপনি পরিবর্তনযোগ্য সেটিং বাদ দিলে, ডিফল্ট ভ্যালু ব্যবহার করা হয়।

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ধাপ, ভেরিয়েবল এবং ফিরে আসা পেলোডের বিস্তারিত উদাহরণের জন্য API এডিট করুন দেখুন।

UI

API এডিট করার সময় সেটিকে বিভাগে ট্যাগ করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।
5. বিভাগ ফিল্ডে ক্লিক করুন এবং নিম্নলিখিত ধাপগুলির মধ্যে একটি সম্পূর্ণ করুন:
   • ড্রপডাউন তালিকা থেকে একটি বিভাগ বেছে নিন।
   • নাম লিখে Enter টিপে নতুন বিভাগ যোগ করুন। নতুন বিভাগটি 'বিভাগ' পৃষ্ঠায় যোগ করা হবে এবং অন্যান্য API যোগ বা এডিট করার সময় উপলভ্য হবে।
6. আরও বিভাগে API ট্যাগ করতে এই প্রসেসটি আবার করুন।
7. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

update কলে এগুলি যোগ করুন:

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

বিভাগের আইডি নম্বর পেতে বিভাগের তালিকা কমান্ড ব্যবহার করুন।

API এডিট করতে:

1. বর্তমান ভ্যালু রিটার্ন করো:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. API এডিট করতে আপডেট কল ব্যবহার করুন। আপনি যে পরিবর্তনযোগ্য ভ্যালু রাখতে চান সেগুলি যোগ করুন এবং যে ভ্যালু পরিবর্তন করতে চান সেগুলি পরিবর্তন করুন। আপনি পরিবর্তনযোগ্য সেটিং বাদ দিলে, ডিফল্ট ভ্যালু ব্যবহার করা হয়।

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ধাপ, ভেরিয়েবল এবং ফিরে আসা পেলোডের বিস্তারিত উদাহরণের জন্য API এডিট করুন দেখুন।

UI

দেখানোর জন্য উপযুক্ত শীর্ষক ও বিবরণ এডিট করতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. এডিট করুন বিকল্পে ক্লিক করুন।
5. প্রয়োজন অনুযায়ী দেখানোর মতো শিরোনাম ও দেখানোর মতো বিবরণ ফিল্ড এডিট করুন।
6. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

update কলে এগুলি যোগ করুন:

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

API এডিট করতে:

1. বর্তমান ভ্যালু রিটার্ন করো:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. API এডিট করতে আপডেট কল ব্যবহার করুন। আপনি যে পরিবর্তনযোগ্য ভ্যালু রাখতে চান সেগুলি যোগ করুন এবং যে ভ্যালু পরিবর্তন করতে চান সেগুলি পরিবর্তন করুন। আপনি পরিবর্তনযোগ্য সেটিং বাদ দিলে, ডিফল্ট ভ্যালু ব্যবহার করা হয়।

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

ধাপ, ভেরিয়েবল এবং ফিরে আসা পেলোডের বিস্তারিত উদাহরণের জন্য API এডিট করুন দেখুন।

UI

আপনার পোর্টাল থেকে কোনও API সরাতে:

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে বেছে নেওয়া না থাকলে, API বেছে নিন।
3. অ্যাকশন মেনু দেখতে, তালিকায় API-এর উপরে কার্সর নিয়ে যান।
4. মুছুন বিকল্পে ক্লিক করুন।

কার্ল

আপনার পোর্টাল থেকে কোনও API সরাতে:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• API_DOC সহ ডকুমেন্টের জেনারেট করা id। যেমন, 399668. এই ভ্যালু খুঁজে পেতে list API docs কমান্ড ব্যবহার করুন।
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।

উত্তরের পেলোড:

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

UI

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. স্ন্যাপশটের স্ট্যাটাস চেক করুন। এটি পুরনো হয়ে গেলে, নিম্নলিখিত মেসেজটি দেখানো হয়:
5. edit এডিট করুন বিকল্পে ক্লিক করুন।
6. নিম্নলিখিত টাস্কগুলির মধ্যে একটি সম্পূর্ণ করুন:
   • পুরনো হয়ে যাওয়া OpenAPI ডকুমেন্টের স্ন্যাপশট রিফ্রেশ করতে, স্ন্যাপশট রিফ্রেশ করুন বিকল্পে ক্লিক করুন।
   • API-এর জন্য ডকুমেন্টেশন তৈরি করতে ব্যবহৃত ডকুমেন্ট পরিবর্তন করতে, API ডকুমেন্টেশনের অধীনে ডকুমেন্ট বেছে নিন বিকল্পে ক্লিক করুন এবং নতুন ডকুমেন্ট বেছে নিন।
7. API ডকুমেন্টেশন প্যানেলে, নিম্নলিখিত বিকল্পগুলির মধ্যে একটি বেছে নিন:
   • OpenAPI ডকুমেন্ট
   • GraphQL স্কিমা
8. ডকুমেন্ট বেছে নিন বিকল্পে ক্লিক করে ডকুমেন্টের লেটেস্ট ভার্সন বেছে নিন।
9. GraphQL-এর জন্য, এন্ডপয়েন্ট URL নির্দিষ্ট করুন।
10. সেভ করুন বিকল্পে ক্লিক করুন।

API রেফারেন্স ডকুমেন্টেশন ডকুমেন্ট থেকে রেন্ডার করা হয় এবং API রেফারেন্স পৃষ্ঠায় যোগ করা হয়। স্ন্যাপশটের স্ট্যাটাস আপডেট করে বর্তমান করা হয়েছে:

কার্ল

OpenAPI বা GraphQL ডকুমেন্টেশনের কন্টেন্ট আপডেট করতে:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

UI

কার্ল

get documentation ব্যবহার করে API ডকুমেন্টেশন ডাউনলোড করতে:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.

• API_DOC সহ ডকুমেন্টের জেনারেট করা id। যেমন, 399668. এই ভ্যালু খুঁজে পেতে list API docs কমান্ড ব্যবহার করুন।

  উত্তরের পেলোড:

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

যেখানে:

contents: API ডকুমেন্টেশনের কন্টেন্টের base64-এনকোড করা স্ট্রিং।

UI

1. API ক্যাটালগ অ্যাক্সেস করুন।
2. আগে থেকে বেছে নেওয়া না থাকলে, API ট্যাবে ক্লিক করুন।
3. আপনি যে API এডিট করতে চান সেটির সারিতে ক্লিক করুন।
4. edit এডিট করুন বিকল্পে ক্লিক করুন।
5. API ডকুমেন্টেশন প্যানেলে, কোনও ডকুমেন্টেশন নেই বিকল্প বেছে নিন।
6. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

আগে থেকে থাকা কন্টেন্ট মুছে দিতে API আপডেট করুন:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• API_DOC সহ ডকুমেন্টের জেনারেট করা id। যেমন, 399668. এই ভ্যালু খুঁজে পেতে list API docs কমান্ড ব্যবহার করুন।

উত্তরের পেলোড:

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

UI

ক্যাটাগরি পৃষ্ঠা দেখতে:

1. প্রকাশ করুন > পোর্টাল বিকল্প বেছে নিয়ে আপনার পোর্টাল বেছে নিন।
2. পোর্টালের হোম পেজে API ক্যাটালগ বিকল্পে ক্লিক করুন।

   অথবা, আপনি পোর্টালের উপরের নেভিগেশন বারে থাকা ড্রপ-ডাউন মেনু থেকে API ক্যাটালগ বেছে নিতে পারেন।

3. বিভাগ ট্যাবে ক্লিক করুন।

API ক্যাটালগের বিভাগ ট্যাবে আপনার পোর্টালের জন্য নির্ধারিত বিভাগের তালিকা দেখানো হয়।

আগের ছবিতে হাইলাইট করা অংশ থেকে বোঝা যায় যে API পৃষ্ঠা আপনাকে এগুলি করতে দেয়:

• যেসব বিভাগ ও API-তে ট্যাগ করা হয়েছে সেগুলি দেখুন
• একটি বিভাগ যোগ করুন
• বিভাগ এডিট করা
• বিভাগ মুছে দেওয়া
• আপনার পোর্টালের জন্য প্রকাশিত API ম্যানেজ করা। API ক্যাটালগ এক্সপ্লোর করুন দেখুন

কার্ল

বিভাগ তালিকাভুক্ত করতে:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।

উত্তরের পেলোড:

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

যেখানে:

• id: বিভাগ আইটেমের আইডি। যেমন, 61c1014c-89c9-40e6-be3c-69cca3505620.

UI

ম্যানুয়ালি বিভাগ যোগ করতে:

1. ক্যাটাগরি পৃষ্ঠা অ্যাক্সেস করুন।
2. + যোগ করুন বিকল্পে ক্লিক করুন।
3. আপনার নতুন বিভাগের নাম লিখুন।
4. বিকল্প হিসেবে, বিভাগে ট্যাগ করার জন্য এক বা একাধিক API বেছে নিন।
5. তৈরি করুন বিকল্পে ক্লিক করুন।

কার্ল

বিভাগ যোগ করতে:

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।
• CATEGORY_NAME সহ বিভাগের নাম। যেমন, demo-backend.

উত্তরের পেলোড:

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

UI

কোনও বিভাগ এডিট করতে:

1. ক্যাটাগরি পৃষ্ঠা অ্যাক্সেস করুন।
2. এডিট করুন বিকল্পে ক্লিক করুন।
3. বিভাগের নাম এডিট করুন।
4. API ট্যাগ যোগ করা বা সরিয়ে দেওয়া।
5. সেভ করুন বিকল্পে ক্লিক করুন।

কার্ল

কোনও বিভাগ এডিট করতে:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• CATEGORY_ID, ক্যাটেগরির আইডি সহ। যেমন, bf6505eb-2a0f-47af-a00a-ded40ac72960. একাধিক বিভাগ আইডি কমা দিয়ে আলাদা করুন। list API categories কমান্ডের মাধ্যমে বিভাগ আইডি পান।
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।
• CATEGORY_NAME সহ বিভাগের নাম। যেমন, demo-backend.

উত্তরের পেলোড:

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

UI

কোনও বিভাগ মুছে দিতে:

1. ক্যাটাগরি পৃষ্ঠা অ্যাক্সেস করুন।
2. আপনি যে বিভাগ এডিট করতে চান সেটির উপরে কার্সর নিয়ে গিয়ে অ্যাকশন মেনু দেখুন।
3. মুছুন বিকল্পে ক্লিক করুন।
4. কনফার্ম করতে মুছুন বিকল্পে ক্লিক করুন।

কার্ল

কোনও বিভাগ মুছে দিতে:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

নিম্নলিখিত বিষয়গুলি পরিবর্তন করুন:

• ORG_NAME সহ সংস্থার নাম। যেমন, my-org
• SITE_ID, যেখানে ORG_NAME হল সংস্থার নাম এবং PORTAL_NAME হল পোর্টালের নাম যা সম্পূর্ণ ছোট হাতের অক্ষরে লেখা এবং স্পেস ও ড্যাশ বাদ দিয়ে পরিবর্তন করা হয়েছে।ORG_NAME-PORTAL_NAME যেমন, my-org-myportal.
• CATEGORY_ID, ক্যাটেগরির আইডি সহ। যেমন, bf6505eb-2a0f-47af-a00a-ded40ac72960. list API categories কমান্ডের মাধ্যমে বিভাগ আইডি পান।
• ACCESS_TOKEN Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত যাচাইকরণ টোকেন সহ । যাচাইকরণ ও টোকেন সম্পর্কে আরও জানতে, Edge API-তে অ্যাক্সেস যাচাই করুন দেখুন।

উত্তরের পেলোড:

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}