webMethods and Intelligent Business Operations 10.2 | API Portal Administrator's Guide | Using and Testing APIs | API Details View
 
API Details View
The API details view displays the details of the selected API such as API description, API Resources, API documents, Access API and Latest posts. You can also look at the discussion on the support forum regarding this API, choose to follow this API, export the API, rate the API or view the list of followers of the selected API.
If the API is a Hybrid API, by default, it is displayed as a REST API and the REST resources are displayed in the API Details view. You can view the SOAP data by clicking the SOAP option.
Field
Description
API name
Displays the API name and the tags associated with the API.
About API name
Displays the name and description of the API.
The API name and description of the API are editable. Hovering over the API name or the API description displays the edit icon, which you can click and edit them as required.
API resources
(For a REST API)
Displays a list of resources available in the API sorted by resource/pathname.
For the REST APIs, the list of resources are displayed in sorted order of the path names. Click each resource to view the corresponding HTTP methods, along with a summary. For each of these methods, details such as tags, parameters and status codes, schema definition, sample request and response are displayed.
If a method is protected by APIKey, OAuth2 or JWT, the same is indicated by a lock symbol.
API methods
(For a SOAP API)
Displays a list of methods available in the API.
For the SOAP APIs, methods are displayed along with their type of binding (SOAP 11 , SOAP 12, and other HTTP methods). Click each method to view details such as input, output, fault messages, and tags.
If a method is protected by APIKey, OAuth2 or JWT, the same is indicated by a lock symbol.
API documents
Displays the list of all documents for the API.
Access API
Displays the list of endpoints for the API.
API scopes
A scope represents a logical grouping of REST resources, methods, or both, and SOAP operations in an API. You can then enforce a specific set of policies on each individual scope in the API.
Displays the scopes associated with the API and the corresponding details such as name of the scope, description of the scope and the methods included in the scope.
If the scope has policies associated, the policies are displayed under a subsection Policies.
Latest posts
Opens a text editor where you can type in your comment, tag the post, attach a link or a file and post it.
Try API
Click this option to test the API. It opens the Try API page. You can provide the various parameters required for the API and test it.
For a REST API, the REST resources that can be tested are displayed in the left panel.
For a SOAP API, the API methods that can be tested are displayed in the left panel.
For a Hybrid API, you can click the REST toggle option, in the left panel, to display the REST resources to be tested and click the SOAP toggle option to display the SOAP methods that can be tested.
Version
Displays the version of the API along with the maturity status, if any, and lists all the versions of the API from the latest to the least in the drop-down list.
Selecting a version from the list displays the API details of that version.
Support forum
Clicking this option navigates you to the Collaboration > My feed view where you can view the recent posts or activity. You can also post it to your feeds.
Get access token
Clicking this option you can request an access token to access and use the API.
This option is available only for the latest API version.
Follow this API
Click to follow this API. If you are already following this API you will see the option Unfollow this API, in which case you can click it to unfollow the API.
Export API as
Click to export the API in the JSON or YAML format.
Download Client SDK
Click to download the Client SDK for the API in the specified language.
Supported languages - Akka-Scala, Android, ASP.NET5, Async-Scala, Clojure, C++Rest, C#, C#.NET2, Cwiki, Dart, Dynamic-Html, Flash, Go, Go-Server, Groovy, Haskell, HTML, HTML2, Inflector, Java, Javascript, Javascript-Closure-Angular, JAXRS, JAXRS-CXF, JAXRS-Rest, JAXRS-Spec, JMeter, Lumen, Nancyfx, Nodejs-Server, Objective C, Perl, Php, Python, Python-Flask, Qt5 C++, Rails5, Ruby, Scala, Scalatra, Silex-Php, Sinatra, Slim, Spring, Swagger, Swagger-Yaml, Swift, Tizen, Typescript-Angular, Typescript-Angular2, Typescript-Fetch, Typescript-Node.
This is available only for REST APIs.
Advanced edit
Click to modify the icon representing the API, API documents and API category for the selected API.
Rate this API
Click the number of stars depending on how you want to rate this API.
Rating is specific to an API version.
List of followers
Displays the number of followers who are following this API.
Followers of a previous API version automatically follow any subsequent higher versions.
Note: The list of followers is not persisted in the following cases :
*A SOAP API republished as REST API or a Hybrid API.
*A REST API or a Hybrid API republished as a REST API.
Associated packages
Displays the associated packages with the API.

Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release