What's API Gateway - webMethods.io Help Center

webMethods API Gateway supports REST-based APIs and SOAP-based APIs, provides protection from malicious attacks, provides a complete run-time governance of APIs ... MENU Release10.7.0 10.11.0 10.7.0 10.5.0 Home Learn DeveloperCenter TECHcommunity EmpowerPortal Top What'sAPIGateway APIGatewayFeatures TenantManagement SearchingData ConfiguringtheNumberofAPIslistedonaPage UsingHelp ManagingFixes Administration GeneralConfiguration SecurityConfiguration AuditLogging ExternalAccounts DestinationConfiguration UserManagement UserManagementinIntegrationCloud UserManagementinSoftwareAGCloud APIs Overview CreatinganAPIbyImportinganAPIfromaFile CreatinganAPIbyImportinganAPIfromaURL CreatinganAPIfromScratch CreatingaRESTAPI APIMashups ViewingAPIListandAPIDetails FilteringAPIs ActivatinganAPI DeactivatinganAPI PublishingAPIs UnpublishingAPIs ModifyingAPIDetails UpdatingAPIs APIMocking AttachingDocumentstoanAPI SOAPtoRESTTransformation CentraSiteProvidedAPIs VersioningAPIs APIScopes ExposingaRESTAPItoApplications ExposingaSOAPAPItoApplications APIGrouping APITagging ExportingAPIs ExportingSpecifications DeletingAPIs Example-ManaginganAPI Policies Overview PolicyValidationandDependencies ManagingThreatProtectionPolicies System-definedStagesandPolicies ManagingGlobalPolicies ManagingAPI-levelPolicies ManagingScope-levelPolicies ManagingPolicyTemplates SupportedAliasandPolicyCombinations Aliases CreatingaSimpleAlias CreatinganEndpointAlias CreatinganHTTPTransportSecurityAlias CreatingaSOAPMessageSecurityAlias CreatingawebMethodsIntegrationServerServiceAlias CreatinganXSLTTransformationAlias Applications Overview CreatinganApplication ViewingListofApplicationsandApplicationDetails RegeneratingAPIAccessKey ModifyingApplicationDetails RegisteringanAPIwithConsumerApplicationsfromAPIDetailsPage RegisteringAPIswithConsumerApplicationsfromApplicationDetailsPage SuspendinganApplication ActivatingaSuspendedApplication PackagesandPlans CreatingaPackage CreatingaPlan ViewingListofPackagesandPackageDetails ModifyingaPackage DeletingaPackage ActivatingaPackage PublishingaPackage ViewingListofPlansandPlanDetails ModifyingaPlan DeletingaPlan ExportingandImportingAssetsandConfigurations Overview ImportingAssetandConfigurationArchives AssetPromotions ManageStages,Promotions,andRollbacks Stages Promotions Rollbacks APIGatewayAnalytics AnalyticsDashboards RuntimeEventsandMetricsDataModel MicrogatewayManagement MicrogatewayGroups MicrogatewayGroupAnalytics MicrogatewayDetails DeletingMicrogatewayInstances RESTAPIsinAPIGateway APIGatewayAdministration AliasManagement ApplicationManagement APIGatewayArchive APIGatewayAvailability DocumentManagement InternalService PolicyManagement PromotionManagement PublicServices APIGatewaySearch ServerInformation ServiceManagement TransactionData UserManagement BackwardcompatibilitysupportforRESTAPIs UsageScenarios ChangeOwnershipofAssets CustomPolicyExtension TeamSupport APIFirstImplementation GatewayEndpoints CustomDestination SecureAPIusingOAuth2withrefreshtokenworkflow webMethodsAPIGatewayenablesanorganizationtosecurelyexposeAPIstoexternaldevelopers,partners,andotherconsumersforuseinbuildingtheirownapplicationsontheirdesiredplatforms. Itprovidesadedicated,web-baseduserinterfacetoperformalltheadministrationandAPIrelatedtaskssuchascreatingAPIs,definingandactivatingpolicies,creatingapplications,andconsumingAPIs.APIGatewaygivesyourichdashboardcapabilitiesforAPIAnalytics. APIscreatedinAPIGatewaycanalsobepublishedtoAPIPortalforexternalfacingdevelopers’consumption.webMethodsAPIGatewaysupportsREST-basedAPIsandSOAP-basedAPIs,providesprotectionfrommaliciousattacks,providesacompleterun-timegovernanceofAPIs,andinformationaboutgateway-specificeventsandAPI-specificevents. APIGatewayFeatures APIGatewayprovidesthesekeyfeatures: SupportforRESTAPIsandSOAPAPIs APIGatewaysupportsREST-basedAPIsandSOAP-basedAPIs.ThissupportenablesorganizationstoleveragetheircurrentinvestmentsinSOAP-basedAPIswhileadoptingRESTfornewAPIs.TheAPIGateway’sSOAPtoRESTtransformationfeatureenablesanAPIprovidertoexposepartsoftheSOAPAPIorexposethecompleteSOAPAPIwithRESTfulinterface.APIGatewayallowsyoutocustomizethewaytheSOAPoperationsareexposedasRESTresources. SecureAPIs APIGatewayprotectsAPIsfrommaliciousattacksinitiatedbyexternalclientapplications.AdministratorscansecuretrafficbetweenAPIconsumerrequestsandtheexecutionofservicesonAPIGatewaybyfilteringrequestscomingfromparticularIPaddressesandblacklistingspecifiedIPaddresses,detectingandfilteringrequestscomingfromparticularmobiledevices. Policyenforcement APIGatewayprovidescompleterun-timegovernanceofAPIs.APIGatewayenforcesaccesstokenssuchasAPIkeycheck,OAuth2tokenandoperationalpoliciessuchassecuritypoliciesforrun-timerequestsbetweenapplicationsandnativeservices.APIproviderscanenforcesecurity,trafficmanagement,monitoring,andSLAmanagementpolicies,cantransformrequestsandresponsesintoexpectedformats,andcollecteventsmetricsonAPIconsumptionandpolicyevaluation.APIPoliciescanbedefinedgloballyandappliedtoasetofAPIs.WithAPIGatewayyoucanalsodefinepolicytemplatesthatcanbeappliedacrossAPIs. Mediation APIGatewayprovidesroutingpoliciessuchascontent-based,andcontext-based,forrun-timerequestsbetweenapplicationsandnativeservices.ThesepoliciesperformroutingandloadbalancingofincomingrequeststoanAPI. Messagetransformation APIGatewayletsyouconfigureanAPIandtotransformtherequestandresponsemessagestosuityourrequirements.Todothis,youcanspecifyanXSLTfiletotransformmessagesduringthemediationprocess.YoucanalsoconfigureanAPItoinvokeIntegrationServerservicestopre-processorpost-processtherequestorresponsemessages. EasydiscoveryandtestingofAPIs APIGatewayprovidesfiltercapabilitiestoquicklyfindAPIsofinterest.APIdescriptionsandadditionaldocumentation,usageexamples,andinformationaboutpoliciesenforcedattheAPIlevelprovidemoredetailstothedevelopersthathelpthemdecidewhethertoadoptaparticularAPI.DeveloperscanusetheprovidedsamplesandexpectederrorandreturncodestoseehowtheAPIworks. Clusteringsupport MultipleinstancesofAPIGatewaycanbeclusteredtogethertoprovidescalabilityandhighavailability. Built-inusageanalytics APIGatewayprovidesinformationaboutGateway-specificeventsandAPI-specificevents,detailsaboutwhichAPIsaremorepopularthanothers.TheGateway-specificeventsinformationisavailablebywayofdashboardstousers.Withthisinformation,providerscanunderstandhowtheirAPIsarebeingused,whichinturncanhelpidentifywaysofimprovingtheirusers’experienceandincreaseAPIadoption. PackagesandPlans APIGatewayprovidescapabilitiestocreateandmanagepackagesandplans.ThishelpstheAPIprovidersinprovidingtieredaccesstotheirAPIstoallowdifferentservicelevelsandpricingplans.Userscanviewthedetailsofthepackage,suchasincludedAPIsandassociatedplans.Plansprovideinformationaboutpricingandqualityofservicetermsdefinedwithinthem.Consumerscansubscribetoanyplanavailableunderthepackage,basedontheirbusinessneeds. FunctionalPrivileges APIGatewayallowsyoutoassignfunctionalprivilegestoauserorgroup(LDAPorlocal)usingteams.Thefunctionalprivilegesaregroupedtogethertoformanteam,whichisassociatedtoagroup.YoumusthaveafunctionalprivilegeassignedtoperformanyofthekeyAPIGatewayfeatures. APIMashups APIGatewayallowsyoutoconsolidateservicesandexposethemasasingleservice.YoucancreateAPImashupsthatextendanAPIoperationbygroupingitwithotherAPIoperationsavailableinAPIGateway. TenantManagement Software AGprovisionsAPICloudintwodifferentplatformsbasedonyourgeographicallocation: IntegrationCloud SoftwareAGCloud TheabovementionedplatformshavetheirownTenantManagementSystemstoauthenticateusers.OnceauserregisterswithAPICloud,thecorrespondingTenantManagementSysteminitiatestheuserregistrationprocess. SearchingData ThesearchfeatureinAPIGatewayisatypeaheadsearch—asimpleandeasytousesearchfacilitywhereyoucantypethetextofinteresttosearch.Youcansearchforallitemsthatcontainoneormorespecifiedkeywords(thatis,textstrings)intheitem’sproperties.Someofthepropertiesarename,description,version,key,value,andsoonintheAPI. Youcanalsosearchforthesedatatypes:APIs,applications,aliases,plans,andpackages. Tosearchforanitem,simplytypeastringinthesearchboxinthetitlenavigationbar.AlistofsearchresultisdisplayeddirectlybelowtheSearchbox.Thenumberofmatchesfoundaredisplayedinfivesectionsdependingonthetypetheyfitin:APIs,Application,Alias,Packages,andPlans.Aminimumoffivesearchresultsaredisplayedineachcategory.Iftherearenoresultsasperthesearchstringtyped,amessagedisplayssayingso. Ifyoufindwhatyouaresearchingforinthesearchresultbox,clickonittoviewthedetails.Youarenavigatedtothespecificpagethatdisplaysmoreinformation.Forexample,ifyouaresearchingforanAPIandclickthedisplayedresult,youarenavigatedtothespecifiedAPIdetailspage.Ifyouaresearchingforanapplicationandclickthedisplayedresult,youarenavigatedtothespecifiedApplicationdetailspage. IfyouwanttoseeallthesearchresultsclickShowallresultsinthesearchresultbox.TheAdvancedsearchpageisdisplayed.Thisisadedicatedpagethatdisplaysextensivesearchresults.IntheAdvancedsearchpage,youcansearchorfiltertheresultsinthefollowingways:bytypeorkeyword. Bytype:Selectoneormoretypesintheleftnavigationpanetoseesearchresultspertainingtotheselectedtypes.Forexample,ifyouselectthetypeAPIs,alltheAPIsthathavethespecifiedstringisdisplayed. Bykeyword:TypeakeywordintheSearchbykeywordfield,allthesearchresultscontainingthespecifiedkeywordaredisplayedinthelist.Forexample,ifyoutypethekeywordpetstore,allsearchresultscontainingthepetstorewouldbefilteredanddisplayed. Note:YoucannotsearchforRESTresourcesandmethodsinaRESTAPI.ThesearchfunctiononlyworksforthenameanddescriptionoftheRESTAPI.Forexample,youcansearchforaRESTAPInamedLibraryAPI.ButyoucannotsearchforaRESTresourcenamedbookoraRESTmethodPOSTwithintheRESTAPI.However,thesearchfunctionworksforname,description,andoperationsofSOAPAPIs.YoucannotsearchforresourcesandmethodsofanODataAPI. ConfiguringtheNumberofAPIslistedonaPage YoucanconfigurethenumberofAPIsthatgetlistedperpageintheManageAPIsortheManageapplicationspage.Ineachofthesepages,youcanusethepaginationbaratthebottomofthepagetonavigatefromonepagetoanother,thefirstpage,orthelastpagewhentherearemorethan20APIsinthelist.TochangethenumberofAPIslistedinapage,selecttherequirednumberintheShow#resultsperpagefieldinthepaginationbaratthebottomofthepage.TheAPIlistnowdisplaysonlythosemanyAPIsinonepageasspecified.Forexample,ifyouselectShow10resultsperpage,only10APIsarelistedinonepage. ThisconfigurationthatyouchangethroughthedropdownismaintainedaslongasyouareloggedintoAPIGateway. ThevalueissetinthedropdownisapplicableforbothAPIsandapplicationslisting.Forexample,ifyouchangetheshowresultsto10intheManageAPIsdropdown,thenthenumberisretainedforManageapplicationspageaswell. UsingHelp APIGateway’sbuilt-incontext-sensitivehelpgivesanoverviewofthefunctionalityofAPIGateway. YoucanaccessAPIGatewayHelplinkbyexpandingthemenuoptionsicon,inthetitlebarandselectingHelp.ThisopenstheintroductiontothewebMethodsAPIGatewaypageinthehelpsystem.Youcanbrowsetherequiredtopicsinthenavigationpane.Clickonatopictodisplaythedetailedinformation.YouwillalsofindthehelplinksintheformofahelpicononseveralpagesoftheAPIGatewayuserinterface.Clickthehelpicononthepagetoviewthecorrespondingdetailedinformation. ManagingFixes APIGatewayUIenablesyoutoupgradetothelatestfix.Whenanewfixisreleased,itshowsupintheAboutpageofAPIGateway. Toperformanyupgrade,youmustbeanAPIGatewayAdministrator. Upgradingtoanewversion Toupgradetoanewversion: ClickfromthetitlebarandselectAbout.YoucanviewtheProductinformationsectionandFixmanagementsectionintheAboutpage.TheProductinformationsectionhastheeditionnameandthecurrentversionofyourAPIGateway. IntheFixManagementsection,youcanviewthefollowingdetailsonthenextavailablefix: Versionnumber.Theversionnumberofthenextavailablefixisdisplayed. Readmedocument.DownloadtheReadmedocumentofthenextavailablefixbyclickingthelinkClickheretodownload. ClickScheduleupgrade. IntheScheduleupgradesection,performthefollowing: a.ClickDateandselectadatefortheupgrade.Theselecteddatelieswithinthenext15days. b.ClickTimeandselectatimewhentheupgradeshouldbedone.Theimmediatetimeavailableforselectionisonehourlaterthanthepresenttime.Youcannotscheduletheupgradeduringtherestrictedtimeframe,whichis9:30PMto12:30AMUTCduetointernalmaintenance. c.IntheEmailIDsfield,typeemailaddressesofthepersonneltobenotifiedwhentheupgradeisscheduledandclick.Youcanaddmultipleemailaddressestobenotified. ClickSave.Thescheduleislistedinthescheduletable.Youcaneditordeletetheschedulebyclickingontheappropriateactionicons. SoftwareAGsendsanemailabouttheupgradescheduled,upgradeinitiationandupgradecompletiontotherespectiveemailaddressessequentially. Note:Atatime,onlyoneupgradeoperationisallowed. Feedback Didyoufindthecontenthelpful? Ihavefeedbackon: ThispageorHelpCenter Specificcontent Clear 0characters Privacypolicy Privacypolicy Theinformationcollectedfromthisformwillbeusedsolelytoimprovethedocumentation.Youremailaddresswillbeusedonlytorespondtoyourfeedback.Clickthelinktoviewthecompleteprivacypolicy. Isthispagehelpful? Yes No Submit Cancel