API Portal Guide

API Portal Guide

API properties

API properties

View the API properties on the API page.
The following table describes the properties of the API page:
Property
Description
Name
Name of the API.
Version
Version of the API. Different versions of a managed API point to different Cloud
Application Integration
processes.
Service Name
Name of the Informatica Cloud
Application Integration
process that the managed API points to.
This field is empty for custom APIs.
Protocol
Protocol of the API. An API can use one of the following protocols:
  • REST
  • SOAP
Status
Status of the API. An API can have the following statuses:
  • Active. The API is active.
  • Inactive. The API is currently not available.
  • Service not available. The Informatica Cloud
    Application Integration
    process that the managed API points to is unavailable or deleted. The managed API is greyed out.
Authentication Method
API authentication method.
A managed API can use one of the following authentication methods:
  • Anonymous. You invoke the managed API without authentication.
  • Basic. To invoke the managed API, you authenticate with an Informatica Intelligent Cloud Services user name and password.
  • OAuth 2.0. You receive OAuth 2.0 client credentials from the
    API Portal
    administrator and use them to generate an OAuth 2.0 authorization token that you then use to invoke the managed API.
  • JSON Web Token (JWT). You generate a token in API Portal and use it to invoke the managed API. You can generate a token for a single managed API, for multiple managed APIs, and for a group of APIs.
A custom API uses anonymous authentication.
Group
Group that the API belongs to.
Description
Description of the API.

0 COMMENTS

We’d like to hear from you!