Concepts for API Cloud v2.0
The following concepts are used when working with API Cloud v2.0:
| Term | Description |
|---|---|
| APIs aka API Application | The application or service that invokes the API published in API Cloud. The client must be subscribed to the target API. |
| API Consumer | Application owners registered with API Cloud, who can discover, subscribe, evaluate, and integrate published APIs with an application. |
| Products | Consumers: API Library for Consumers to search, discover and consume Products. |
| API Policy | A configurable object in API Cloud that controls authentication, consumption rate, and throttling. API Cloud provides preconfigured policies and custom policies. |
| Product | API Product is a mandatory requirement in the API publish process. API Product allows a publisher to bundle several API proxies into a package. This facilitates proper consumer engagement. For more details refer to the API Product section. |
| API Proxy | API frontend server that authenticates and authorizes API consumption. It routes API requests, aggregates API responses, and enforces API policies. See also, API Policy |
| API Publisher | The API owner who is responsible for creating, publishing, versioning and gathering metrics of the API in API CloudAPI . |
| API Visibility | API Visibility is an API product that controls who can access your API. For more details refer to API Visibility and Team Roles. |
| Backend API | A service’s endpoint that is hosted by the API provider and is proxied through the API Gateway or API Proxy. The API Proxy secures the backend API and exposes it for client access. |
| Basic Publisher Flow | Publishers access the Trimble Cloud Console to publish APIs. |
| REST | Representational State Transfer |
| Target Endpoint | Refers to the Backend service endpoint. See also Backend API. |
| Team Space | Each Team Space includes a virtual workspace to collaborate API development. Team Admins manage Team Space and Team Members. For details on managing team members, refer to the API visibility and roles. |
| Traffic Management (DEPRECATED) | API policy that optimizes traffic and latency of an API. Custom policies that help you maintain this are Rate Limiting and Quota. |