Get started

API Management 3.0 enables you to define services and publish endpoints for internal and external consumption. In the world of technology, the terms server, service, endpoint, policy, and rule have many definitions. In the context of API Management 3.0:

According to version 3 of the OpenAPI Specification (OAS), a server is the API gateway that handles requests. In APIM 3.0, the Server is a Snaplex node. Refer to Runtime architecture for more information.
A service is a collection of endpoints. SnapLogic Service endpoints are:
- Native resources: Triggered or Ultra Tasks that execute on the same Snaplex as the Service.
- External resources: Third-party APIs or SnapLogic tasks that execute on a different Snaplex from the Service and require an additional network call to the external server. Refer to Request execution flow for more information.
An endpoint makes Service functionality available to individuals or applications. It's an access point that enables communication with the Service and maps to one native or external resource.
Service endpoint URL has the following form:
```
https://hostname/gateway/URL-slug/version/endpoint-paths/
```
It includes these components:
- Hostname: The root address. For an endpoint executing on a Cloudplex, a hostname of: https://snaplogic.io. For an endpoint executing on a Groundplex, your hostname or IP address.
- URL-slug: A unique value that identifies the Service. For example: MyService
- Version: The user-specified version. For example: v1.
- Resource Path: One or more paths defined for the endpoint. For example: users.
A Service endpoint also includes:
- HTTP Methods: The type of request. For example: GET, POST, PUT, DELETE.
- Headers: Additional information such as authentication tokens and content type.
- Optional query parameters: Modify the request. For example: ?limit=10.
Policies are collections of rules that you can apply to all Services, a single Service, or specific Service endpoints.
Rules define validation, authentication, authorization, behavior such as request mapping, redirecting, caching, and transformation for the request and optional transformation for the response. The Snaplex node applies the Policy rules at the appropriate point during execution.

General steps to create and publish a Service

You can create a Service in any of these ways:

By referencing an existing Triggered or Ultra Task.
By referencing an external endpoint URL.
From an OpenAPI Specification (OAS).

Assign a meaningful name, a version, and a description. Once created, the SnapLogic Platform stores the Service as a SnapLogic asset. You can view it in the Services Catalog, add endpoints, and apply Policies.

To validate and secure the Service, define one or more Policies. A Policy contains one or more rules that a Snaplex node executes at runtime. Learn more about Policies and rules.

After testing a Service, change its status to publish it in the DeveloperHub and make it available to consumers. The DeveloperHub is a customizable site where internal and external consumers can view, test, and use Services.

Reuse legacy APIM resources

If your organization is already subscribed to SnapLogic API Management (APIM), API Management 3.0 provides access to the legacy interface and migration for existing API Versions and Proxies. Migration includes Policies and other SnapLogic assets. Leverage existing APIs and Proxies by migrating, testing and validating, and publishing them when ready.

What's next

Choose the next step on your learning path: