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

UI

এপিআই ক্যাটালগ দেখতে:

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

এপিআই ক্যাটালগের এপিআই ট্যাবে আপনার পোর্টালে যুক্ত করা এপিআইগুলোর একটি তালিকা প্রদর্শিত হয়।

পূর্ববর্তী চিত্রে যেমনটি তুলে ধরা হয়েছে, এপিআই (APIs) ট্যাবটি আপনাকে নিম্নলিখিত কাজগুলো করতে দেয়:

• আপনার পোর্টালে উপলব্ধ এপিআইগুলির বিবরণ দেখুন
• আপনার পোর্টালে একটি API যোগ করুন
• নিম্নলিখিত এক বা একাধিক কাজ সম্পাদন করে আপনার পোর্টালে একটি API সম্পাদনা করুন:
  • এপিআই রেফারেন্স ডকুমেন্টেশন আপডেট করার জন্য একটি এপিআই প্রোডাক্টের সাথে যুক্ত ডকুমেন্টের স্ন্যাপশট পরিচালনা করুন।
  • আপনার পোর্টালে একটি API প্রকাশ বা অপ্রকাশ করুন
  • আপনার পোর্টালে একটি এপিআই-এর দৃশ্যমানতা পরিচালনা করুন :
  • একটি API-এর জন্য কলব্যাক URL পরিচালনা করুন
  • একটি এপিআই কার্ডের জন্য ছবিটি পরিচালনা করুন
  • ক্যাটাগরি ব্যবহার করে একটি এপিআই ট্যাগ করুন
  • এপিআই শিরোনাম এবং বিবরণ সম্পাদনা করুন
• আপনার পোর্টাল থেকে একটি API সরান
• সম্পর্কিত এপিআই খুঁজে বের করতে ব্যবহৃত ক্যাটাগরিগুলো পরিচালনা করুন
• স্পেক স্টোর থেকে পুরোনো বা মুছে ফেলা স্পেকগুলো দ্রুত শনাক্ত করুন।
• Apigee Edge থেকে যেসব অনাথ API-এর সংশ্লিষ্ট 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 ।
• Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত অথেনটিকেশন টোকেনটি হলো ACCESS_TOKEN । অথেনটিকেশন এবং টোকেন সম্পর্কে আরও তথ্যের জন্য, 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 : ইপক থেকে ক্যাটালগ আইটেমটি সর্বশেষ পরিবর্তিত হওয়ার সময় (মিলিসেকেন্ডে)। উদাহরণস্বরূপ, 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 হলো একটি পৃষ্ঠায় প্রদর্শিত তালিকার আইটেমের সংখ্যা। উদাহরণস্বরূপ, ১০।
  • PAGE_TOKEN এর সাথে nextPageToken ভ্যালুটি থাকবে। উদাহরণস্বরূপ, 7zcqrin9l6xhi4nbrb9 ।

UI

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

1. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
2. যদি আগে থেকে নির্বাচিত না থাকে, তাহলে API ট্যাবটিতে ক্লিক করুন।

3. যোগ করুন - এ ক্লিক করুন ।

   ক্যাটালগে একটি এপিআই পণ্য যোগ করার ডায়ালগ বক্সটি প্রদর্শিত হয়।

4. আপনার পোর্টালে যে এপিআই পণ্যটি যোগ করতে চান, সেটি নির্বাচন করুন।

5. পরবর্তী ধাপে যান। এপিআই বিবরণী পৃষ্ঠাটি প্রদর্শিত হবে।

6. পোর্টালে এপিআই রেফারেন্স ডকুমেন্টেশনের বিষয়বস্তু এবং এর দৃশ্যমানতা কনফিগার করুন:

   মাঠ	বর্ণনা
   প্রকাশিত	আপনার পোর্টালে API-টি প্রকাশ করতে ‘Published’ নির্বাচন করুন। আপনি যদি API-টি প্রকাশ করার জন্য প্রস্তুত না থাকেন, তবে চেকবক্সটি থেকে টিক চিহ্ন তুলে দিন। ‘Publish or unpublish an API on your portal’ অংশে বর্ণিত পদ্ধতি অনুসরণ করে আপনি পরবর্তীতে এই সেটিংটি পরিবর্তন করতে পারবেন।
   শিরোনাম প্রদর্শন করুন	ক্যাটালগে প্রদর্শিত আপনার API-এর শিরোনাম আপডেট করুন। ডিফল্টরূপে, API পণ্যের নামটি ব্যবহৃত হয়। 'প্রদর্শনের শিরোনাম এবং বিবরণ সম্পাদনা করুন' অংশে বর্ণিত পদ্ধতি অনুসরণ করে আপনি পরবর্তীতে প্রদর্শিত শিরোনামটি পরিবর্তন করতে পারেন।
   বিবরণ প্রদর্শন করুন	ক্যাটালগে প্রদর্শিত আপনার API-এর বিবরণ আপডেট করুন। ডিফল্টরূপে, API পণ্যের বিবরণ ব্যবহৃত হয়। আপনি পরবর্তীতে প্রদর্শিত বিবরণ পরিবর্তন করতে পারেন, যেমনটি 'প্রদর্শনের শিরোনাম এবং বিবরণ সম্পাদনা করুন' অংশে বর্ণনা করা হয়েছে।
   ডেভেলপারদের একটি কলব্যাক ইউআরএল নির্দিষ্ট করতে হবে।	অ্যাপ ডেভেলপারদের জন্য একটি কলব্যাক ইউআরএল নির্দিষ্ট করা বাধ্যতামূলক করতে চাইলে এটি সক্রিয় করুন। ‘একটি এপিআই-এর জন্য কলব্যাক ইউআরএল পরিচালনা করুন ’ অংশে বর্ণিত পদ্ধতি অনুযায়ী আপনি পরবর্তীতে কলব্যাক ইউআরএলটি যোগ বা আপডেট করতে পারবেন।
   এপিআই ডকুমেন্টেশন	একটি OpenAPI ডকুমেন্ট ব্যবহার করতে: OpenAPI ডকুমেন্ট নির্বাচন করুন। ডকুমেন্ট নির্বাচন করুন -এ ক্লিক করুন। নিম্নলিখিত ধাপগুলোর মধ্যে যেকোনো একটি অনুসরণ করুন: 'My Specs' ট্যাবে ক্লিক করুন এবং স্পেক স্টোর থেকে একটি স্পেক বেছে নিন। আপলোড ফাইল ট্যাবে ক্লিক করুন এবং একটি ফাইল আপলোড করুন। 'Import from a URL' ট্যাবে ক্লিক করুন এবং একটি URL থেকে স্পেক ইম্পোর্ট করুন। নির্বাচন করুন- এ ক্লিক করুন। একটি GraphQL স্কিমা ব্যবহার করতে: GraphQL স্কিমা নির্বাচন করুন। ডকুমেন্ট নির্বাচন করুন -এ ক্লিক করুন। GraphQL স্কিমাটিতে যান এবং সেটি নির্বাচন করুন। নির্বাচন করুন- এ ক্লিক করুন। বিকল্পভাবে, আপনি ‘কোনো ডকুমেন্টেশন নেই’ নির্বাচন করতে পারেন এবং ‘ডকুমেন্টের স্ন্যাপশট পরিচালনা’ অংশে বর্ণিত পদ্ধতি অনুযায়ী এপিআই যোগ করার পরে একটি ডকুমেন্টেশন যোগ করতে পারেন।
   এপিআই দৃশ্যমানতা	আপনি যদি অডিয়েন্স ম্যানেজমেন্ট ফিচারের বিটা রিলিজে নথিভুক্ত না হয়ে থাকেন, তাহলে নিচের অপশনগুলো থেকে একটি বেছে নিন: সকল ব্যবহারকারীকে এপিআই দেখার অনুমতি দেওয়ার জন্য পরিচয় গোপনকারী ব্যবহারকারী । শুধুমাত্র নিবন্ধিত ব্যবহারকারীরাই এপিআই (API) দেখতে পারবেন। আপনি যদি অডিয়েন্স ম্যানেজমেন্ট ফিচারের বিটা সংস্করণে নথিভুক্ত হয়ে থাকেন, তাহলে নিম্নলিখিত বিকল্পগুলির মধ্যে একটি নির্বাচন করুন: পাবলিক (যে কেউ দেখতে পারে) যাতে সকল ব্যবহারকারী এপিআইটি দেখতে পারে। শুধুমাত্র নিবন্ধিত ব্যবহারকারীদের এপিআই দেখার অনুমতি দেওয়ার জন্য প্রমাণীকৃত ব্যবহারকারী । নির্বাচিত দর্শকশ্রেণী থেকে সেই নির্দিষ্ট দর্শকশ্রেণীকে নির্বাচন করুন, যারা এপিআই (API) দেখতে পারবে। আপনি পরবর্তীতে অডিয়েন্সের দৃশ্যমানতা পরিচালনা করতে পারবেন, যেমনটি "আপনার পোর্টালে একটি API-এর দৃশ্যমানতা পরিচালনা করুন" অংশে বর্ণনা করা হয়েছে।
   ছবি প্রদর্শন করুন	এপিআই পেজে এপিআই কার্ডে একটি ছবি প্রদর্শন করতে, 'Select image'-এ ক্লিক করুন। 'Select image' ডায়ালগে, একটি বিদ্যমান ছবি নির্বাচন করুন, একটি নতুন ছবি আপলোড করুন, অথবা একটি বাহ্যিক ছবির ইউআরএল (URL) প্রদান করুন এবং 'Select'-এ ক্লিক করুন। এপিআই থাম্বনেইলটির প্রিভিউ দেখুন এবং 'Select'-এ ক্লিক করুন। 'Manage the image for an API card'- এ বর্ণিত পদ্ধতি অনুসরণ করে আপনি পরে একটি ছবি যোগ করতে পারেন। যখন একটি বাহ্যিক ইউআরএল (URL) দিয়ে ছবি নির্দিষ্ট করা হয়, তখন ছবিটি আপনার অ্যাসেটসে আপলোড হবে না; উপরন্তু, ইন্টিগ্রেটেড পোর্টালে ছবিটি লোড হওয়া তার প্রাপ্যতার উপর নির্ভরশীল হবে, যা কন্টেন্ট নিরাপত্তা নীতি দ্বারা ব্লক বা সীমাবদ্ধ করা হতে পারে।
   বিভাগগুলি	অ্যাপ ডেভেলপারদের এপিআই পেজে সম্পর্কিত এপিআই খুঁজে পেতে সক্ষম করার জন্য, এপিআই-কে যে বিভাগগুলিতে ট্যাগ করা হবে সেগুলি যোগ করুন। একটি বিভাগ শনাক্ত করতে: ড্রপ-ডাউন তালিকা থেকে একটি বিভাগ নির্বাচন করুন। নতুন ক্যাটাগরি যোগ করতে এর নাম টাইপ করে এন্টার চাপুন। নতুন ক্যাটাগরিটি ক্যাটাগরি পেজে যুক্ত হবে এবং অন্যান্য এপিআই যোগ বা সম্পাদনা করার সময় উপলব্ধ হবে।

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 ।
• Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত অথেনটিকেশন টোকেনটি হলো ACCESS_TOKEN । অথেনটিকেশন এবং টোকেন সম্পর্কে আরও তথ্যের জন্য, Edge API-তে অ্যাক্সেস অথেনটিকেট করুন দেখুন।
• প্রদর্শনের শিরোনাম সহ TITLE । উদাহরণস্বরূপ, Hello World 2 ।
• প্রদর্শনের বিবরণ সহ DESCRIPTION । উদাহরণস্বরূপ, Simple hello world example ।
• ANON_TRUE_OR_FALSE , যেখানে true বা false (ডিফল্ট) true হলো এই API-টি সর্বসাধারণের জন্য উন্মুক্ত এবং পরিচয় গোপন রেখে দেখা যাবে; অন্যথায়, শুধুমাত্র নিবন্ধিত ব্যবহারকারীরাই এটি দেখতে পারবেন।
• ক্যাটালগ আইটেমের জন্য ব্যবহৃত বাহ্যিক ছবির URL, অথবা পোর্টালে সংরক্ষিত ইমেজ ফাইলের ফাইল পাথ (যেমন, /files/book-tree.jpg ) IMAGE_URL হিসেবে ব্যবহার করুন। বাহ্যিক ছবির 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 হলো এপিআই প্রোডাক্টের নাম। উদাহরণস্বরূপ, 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 : ইপক থেকে ক্যাটালগ আইটেমটি সর্বশেষ পরিবর্তিত হওয়ার সময় (মিলিসেকেন্ডে)। উদাহরণস্বরূপ, 1698165480000 ।
• id : ক্যাটালগ আইটেমটির আইডি। উদাহরণস্বরূপ, 399668 ।

UI

একটি API সম্পাদনা করতে:

1. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
2. যদি আগে থেকে নির্বাচিত না থাকে, তাহলে API ট্যাবটিতে ক্লিক করুন।
3. আপনি API-এর যে সারিটি সম্পাদনা করতে চান, সেটিতে ক্লিক করুন।
4. ক্লিক করুন সম্পাদনা করুন ।
5. API বিবরণের অধীনে, যেকোনো পরিবর্তন করুন। একটি API যোগ করুন -এ বিকল্পগুলির বিবরণ দেখুন।
6. সংরক্ষণ করুন- এ ক্লিক করুন।

কার্ল

একবার এপিআই যোগ করার পর, সম্পাদনা করার জন্য আপডেট কলটি ব্যবহার করুন।

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

1. প্রতিটি এপিআই-কে অনন্যভাবে শনাক্তকারী জেনারেটেড id খুঁজে বের করার জন্য, ‘এক্সপ্লোর এপিআই’ অংশে বর্ণিত পদ্ধতি অনুযায়ী আপনার পোর্টালে থাকা এপিআইগুলোর একটি তালিকা সংগ্রহ করুন।

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 ।
   • ডকুমেন্টের তৈরি হওয়া id সহ API_DOC । উদাহরণস্বরূপ, 399668 এই মানটি খুঁজে পেতে list API docs কমান্ডটি ব্যবহার করুন।
   • Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত অথেনটিকেশন টোকেনটি হলো ACCESS_TOKEN । অথেনটিকেশন এবং টোকেন সম্পর্কে আরও তথ্যের জন্য, 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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
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

এপিআই সম্পাদনা করতে:

1. বর্তমান মানগুলি ফেরত দিন :

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

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

   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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
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

এপিআই সম্পাদনা করতে:

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. এপিআই সম্পাদনা করতে আপডেট কলটি ব্যবহার করুন। যে পরিবর্তনযোগ্য মানগুলো আপনি রাখতে চান তা অন্তর্ভুক্ত করুন এবং যে মানগুলো পরিবর্তন করতে চান তা সংশোধন করুন। যদি আপনি কোনো পরিবর্তনযোগ্য সেটিং বাদ দেন, তাহলে ডিফল্ট মানটি ব্যবহৃত হবে।

   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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
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

এপিআই সম্পাদনা করতে:

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. এপিআই সম্পাদনা করতে আপডেট কলটি ব্যবহার করুন। যে পরিবর্তনযোগ্য মানগুলো আপনি রাখতে চান তা অন্তর্ভুক্ত করুন এবং যে মানগুলো পরিবর্তন করতে চান তা সংশোধন করুন। যদি আপনি কোনো পরিবর্তনযোগ্য সেটিং বাদ দেন, তাহলে ডিফল্ট মানটি ব্যবহৃত হবে।

   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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
2. যদি আগে থেকে নির্বাচিত না থাকে, তাহলে API ট্যাবটিতে ক্লিক করুন।
3. আপনি API-এর যে সারিটি সম্পাদনা করতে চান, সেটিতে ক্লিক করুন।
4. ক্লিক করুন সম্পাদনা করুন ।

5. এপিআই বিবরণের অধীনে:

   • ছবি নির্দিষ্ট করতে অথবা কোনো ছবি নির্বাচিত না থাকলে একটি ছবি আপলোড করতে 'Select image'- এ ক্লিক করুন।
   • অন্য কোনো ছবি নির্দিষ্ট করতে বা আপলোড করতে 'Change image'-এ ক্লিক করুন।
   • ছবিটি সরাতে এর ওপর থাকা x- এ ক্লিক করুন।

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

6. সংরক্ষণ করুন- এ ক্লিক করুন।

কার্ল

update কলে নিম্নলিখিতগুলি অন্তর্ভুক্ত করুন:

  # Omit line for no image file

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

এপিআই সম্পাদনা করতে:

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. এপিআই সম্পাদনা করতে আপডেট কলটি ব্যবহার করুন। যে পরিবর্তনযোগ্য মানগুলো আপনি রাখতে চান তা অন্তর্ভুক্ত করুন এবং যে মানগুলো পরিবর্তন করতে চান তা সংশোধন করুন। যদি আপনি কোনো পরিবর্তনযোগ্য সেটিং বাদ দেন, তাহলে ডিফল্ট মানটি ব্যবহৃত হবে।

   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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
2. যদি আগে থেকে নির্বাচিত না থাকে, তাহলে API ট্যাবটিতে ক্লিক করুন।
3. আপনি API-এর যে সারিটি সম্পাদনা করতে চান, সেটিতে ক্লিক করুন।
4. ক্লিক করুন সম্পাদনা করুন ।
5. ক্যাটাগরি ফিল্ডের মধ্যে ক্লিক করুন এবং নিম্নলিখিত ধাপগুলির মধ্যে একটি অনুসরণ করুন:
   • ড্রপ-ডাউন তালিকা থেকে একটি বিভাগ নির্বাচন করুন।
   • নতুন ক্যাটাগরি যোগ করতে এর নাম টাইপ করে এন্টার চাপুন। নতুন ক্যাটাগরিটি ক্যাটাগরি পেজে যুক্ত হবে এবং অন্যান্য এপিআই যোগ বা সম্পাদনা করার সময় উপলব্ধ হবে।
6. এপিআই-টিকে আরও ক্যাটাগরিতে ট্যাগ করতে পুনরাবৃত্তি করুন।
7. সংরক্ষণ করুন- এ ক্লিক করুন।

কার্ল

update কলে নিম্নলিখিতগুলি অন্তর্ভুক্ত করুন:

  # Omit line for no categories

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

ক্যাটাগরি আইডি নম্বরগুলো পেতে `list categories` কমান্ডটি ব্যবহার করুন।

এপিআই সম্পাদনা করতে:

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. এপিআই সম্পাদনা করতে আপডেট কলটি ব্যবহার করুন। যে পরিবর্তনযোগ্য মানগুলো আপনি রাখতে চান তা অন্তর্ভুক্ত করুন এবং যে মানগুলো পরিবর্তন করতে চান তা সংশোধন করুন। যদি আপনি কোনো পরিবর্তনযোগ্য সেটিং বাদ দেন, তাহলে ডিফল্ট মানটি ব্যবহৃত হবে।

   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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
2. যদি আগে থেকে নির্বাচিত না থাকে, তাহলে API ট্যাবটিতে ক্লিক করুন।
3. আপনি API-এর যে সারিটি সম্পাদনা করতে চান, সেটিতে ক্লিক করুন।
4. ক্লিক করুন সম্পাদনা করুন ।
5. প্রয়োজন অনুযায়ী ডিসপ্লে শিরোনাম এবং ডিসপ্লে বিবরণ ক্ষেত্রগুলি সম্পাদনা করুন।
6. সংরক্ষণ করুন- এ ক্লিক করুন।

কার্ল

update কলে নিম্নলিখিতগুলি অন্তর্ভুক্ত করুন:

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

এপিআই সম্পাদনা করতে:

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. এপিআই সম্পাদনা করতে আপডেট কলটি ব্যবহার করুন। যে পরিবর্তনযোগ্য মানগুলো আপনি রাখতে চান তা অন্তর্ভুক্ত করুন এবং যে মানগুলো পরিবর্তন করতে চান তা সংশোধন করুন। যদি আপনি কোনো পরিবর্তনযোগ্য সেটিং বাদ দেন, তাহলে ডিফল্ট মানটি ব্যবহৃত হবে।

   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. এপিআই ক্যাটালগ অ্যাক্সেস করুন ।
2. এপিআইগুলো নির্বাচন করুন, যদি আগে থেকে নির্বাচিত না থাকে।
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 ।
• ডকুমেন্টের তৈরি হওয়া id সহ API_DOC । উদাহরণস্বরূপ, 399668 এই মানটি খুঁজে পেতে list API docs কমান্ডটি ব্যবহার করুন।
• Apigee Edge API অ্যাক্সেস করার জন্য ব্যবহৃত অথেনটিকেশন টোকেনটি হলো ACCESS_TOKEN । অথেনটিকেশন এবং টোকেন সম্পর্কে আরও তথ্যের জন্য, Edge API-তে অ্যাক্সেস অথেনটিকেট করুন দেখুন।

প্রতিক্রিয়া পেলোড:

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

UI

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

ডকুমেন্ট থেকে এপিআই রেফারেন্স ডকুমেন্টেশন রেন্ডার করে এপিআই রেফারেন্স পেজে যোগ করা হয়। স্ন্যাপশট স্ট্যাটাসটি 'কারেন্ট' হিসেবে আপডেট করা হয়:

কার্ল

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

কার্ল

To download API documentation using get documentation :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .

• API_DOC with the generated id of the document. For example, 399668 . Use the list API docs command to find this value.

  Response payload:

{
  "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 : The base64-encoded string of contents of the API documentation.

UI

1. Access the API catalog .
2. Click the APIs tab, if not already selected.
3. Click in the row of the API that you want to edit.
4. Click edit Edit .
5. In the API documentation pane, select No documentation .
6. সংরক্ষণ করুন- এ ক্লিক করুন।

কার্ল

To clear existing content use the update 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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• API_DOC with the generated id of the document. For example, 399668 . Use the list API docs command to find this value.

Response payload:

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

UI

To view the Categories page:

1. Select Publish > Portals and select your portal.
2. Click API catalog on the portal home page.

   Alternatively, you can select API catalog in the portal drop-down menu in the top navigation bar.

3. Click the Categories tab.

The Categories tab in the API catalog displays the list of the categories that have been defined for your portal.

As highlighted in the previous figure, the APIs page enables you to:

• View the categories and the APIs to which they are tagged
• একটি বিভাগ যোগ করুন
• Edit a category
• Delete a category
• Manage APIs published to your portal. See Explore the API catalog

কার্ল

To list categories :

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

নিম্নলিখিতগুলি প্রতিস্থাপন করুন:

• ORG_NAME with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .

Response payload:

{
  "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 : The ID of the category item. For example, 61c1014c-89c9-40e6-be3c-69cca3505620 .

UI

To manually add a category:

1. Access the Categories page .
2. Click + Add .
3. Enter the name of your new category.
4. Optionally, select one or more APIs to tag to the category.
5. তৈরি করুন- এ ক্লিক করুন।

কার্ল

To add a category :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .
• CATEGORY_NAME with the name of the category. For example, demo-backend .

Response payload:

{
  "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

To edit a category:

1. Access the Categories page .
2. ক্লিক করুন সম্পাদনা করুন ।
3. Edit the name of the category.
4. Add or remove API tags.
5. সংরক্ষণ করুন- এ ক্লিক করুন।

কার্ল

To edit a category :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• CATEGORY_ID with the ID of the category. For example, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Separate multiple category IDs with a comma. Get the category ID with the list API categories command.
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .
• CATEGORY_NAME with the name of the category. For example, demo-backend .

Response payload:

{
  "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

To delete a category:

1. Access the Categories page .
2. Position your cursor over the category that you want to edit to display the actions menu.
3. ক্লিক করুন মুছে ফেলুন ।
4. নিশ্চিত করতে ডিলিট-এ ক্লিক করুন।

কার্ল

To delete a category :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• CATEGORY_ID with the ID of the category. For example, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Get the category ID with the list API categories command.
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .

Response payload:

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