Portal API (PAPI)
You can programmatically access key aan entities that are exposed as RESTful resources using the Portal API. You can call the Portal API from your external client application, or you can try it out using the API Explorer in the aan.
apip42
You can programmatically access key
API Portal
entities that are exposed as RESTful resources using the Portal API. You can call the Portal API from your external client application, or you can try it out using the API Explorer in the API Portal
.In this article:
2
Swagger File
The swagger file describing the Portal API can be viewed and is available for download:
Resources
The following resources are available:
- AccountPlansUse this resource to manage account plans. API publishers can use account plans to grant or restrict access to developer organizations, apply usage restrictions, and provide access to private APIs.The AccountPlans POST method requires the
value. You can add an autogenerated UUID while creating your users using:UUID"Uuid": "{{GENERATED_GUID}}"This method does not require values forOldPasswordandNewPassword. You can leave them as null. - ApiDeploymentsUse this resource to manage the deployment details for a specific proxy. A proxy is a runtime environment where APIs, applications, and account plans are deployed.
- ApiEulasUse this resource to manage the End User License Agreements (EULAs). A EULA is a set of legal restrictions that you can apply toward the usage of any API managed in theAPI Portal.
- ApiGroupsUse this resource to manage the API groups.
- ApisUse this resource to manage APIs, retrieve the Swagger definition for a specific API, and retrieve relevant Gateway policy templates using
./policyTemplates - ApplicationsUse this resource to manage applications. An application is a construct that uses one or more APIs.
- CustomFieldsUse this resource to manage custom fields. A custom field describes extra metadata that API Gateway administrators can use in their policies.
- OrganizationsUse this resource to manage organizations. An organization is a group of one or more developers, typically representing a team or department within a business organization.
- ProxiesUse this resource to manage the proxies that are associated with theAPI Portal.
- RequestsUse this resource to manage requests. A request is request from a developer for acceptance or rejection by administrators or API owners.
- SearchUse this resource to search forAPI Portalentities by keyword.
- SettingsUse this resource to retrieve or update anAPI Portalsetting that corresponds to a specific functionality (such as Google Analytics tracking forAPI Portalpages).
- ThemesUse this resource to manageAPI Portalthemes. A theme defines the look of yourAPI Developer Portal.
- UsersUse this resource to manageAPI Portaluser accounts. You can look up supported languages for the user interface using
. Each user must have a specific developer or publisher role within an organization. You can look up available roles using/languages
and/developerRoleTypes
, respectively./publisherRoleTypes
Requests and responses are in JSON format.
For more information about JSON format, see the JSON.org website.
Access the Portal API
- While logged in to theAPI Portalas a Portal administrator for the intended tenant, click theServicesicon.
- ClickPortalAPI.
- Select thePortal APIoption from theAPIdrop-down list.
The API Explorer appears in the right pane, showing the Portal API.
Authentication
Portal API calls require a valid OAuth token.
For more information about OAuth tokens, see the OAuth Community Site.
For CA API Management OAuth Toolkit users,request the access token by posting using the
application/x-www-form-urlencoded
Content-Type.