How-to guides

Users can create the API Gateway service by entering required information through the Samsung Cloud Platform Console and selecting detailed options.

Creating an API

An API is a collection of resources and methods integrated with backend HTTP endpoints, Cloud Functions, or other SCP services. An API provides a logical interface to the actual service and can be deployed to multiple stages for use in different environments (development, production, etc.).

You can create and use APIs through the Samsung Cloud Platform Console.

To create an API, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the Create API button on the Service Home page. This will take you to the Create API page.

3. Enter the required information for creating the service and select detailed options on the Create API page.

   • Select the required information in the Service Information section.

     Item	Required	Description
     API Name	Required	Enter API name Start with lowercase English letters, do not end with special characters (-), and enter 3 ~ 50 characters using lowercase letters, numbers, and special characters (-)
     API Creation Method	Required	Select API creation method Select from Create New, Clone Existing API
     API to Clone	Required	When selecting Clone Existing API as the API creation method, select from already created APIs
     Description	Optional	Enter additional information or description about the API within 50 characters
     API Endpoint Type	Required	Path to access the API Region: Process requests within the region where the API is deployed Private: Expose to receive API requests privately from other VPCs When Private is selected, JWT activation is applied

     Table. API service information input items
   • Enter or select the required information in the Additional Information section.

     Item	Required	Description
     Tags	Optional	Add tags Click the Add Tag button to create and add a new tag or add an existing tag Up to 50 tags can be added Newly added tags are applied after service creation is complete

     Table. API additional information input items

4. Review the detailed information and estimated charges in the Summary panel, then click the Complete button.

   • Once creation is complete, verify the created resource on the API List page.

Viewing API Details

You can view and modify the complete resource list and detailed information of API services. The API Details page consists of Details, Tags, and Operation History tabs.

To view detailed information of an API service, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API menu on the Service Home page. This will take you to the API List page.
3. Click the resource for which you want to view detailed information on the API List page. This will take you to the API Details page.
   • The API Details page displays status information and additional feature information, and consists of Details, Tags, and Operation History tabs.

     Item	Description
     Status Display	Status of the API created by the user Creating: API being created Active: API operating normally Deleting: API being deleted Error: Service unavailable due to API internal error
     Service Termination	Button to terminate the service

     Table. API status information and additional features

Details

On the API Details page, you can view detailed information of the selected resource and modify information if necessary.

Connection Management

On the Connection Management page, you can manage connection requests for PrivateLink Service for API Gateway.

Tags

On the API Details page, you can view tag information of the selected resource, and add, modify, or delete tags.

Operation History

On the API Details page, you can view the operation history of the selected resource.

Integrating with PrivateLink Service

By integrating API Gateway service with PrivateLink service, you can connect ‘API Gateway and VPC’ or ‘API Gateway and other SCP services’ without external internet. Data uses only the internal network, providing high security, and no public IP, NAT, VPN, or internet gateway is required.

Creating PrivateLink Service for API Gateway Service

When creating an API, select the endpoint type as Private. You can expose the API to be accessed privately from other VPCs or services.

Creating a PrivateLink Endpoint

You can create an entry point to access other PrivateLinks in API Gateway service.

To create a PrivateLink Endpoint, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the PrivateLink Endpoint menu on the Service Home page. This will take you to the PrivateLink Endpoint List page.

3. Click the Create PrivateLink Endpoint button on the PrivateLink Endpoint List page. This will take you to the Create PrivateLink Endpoint page.

   • Enter or select the required information.

     Item	Required	Description
     PrivateLink Endpoint Name	Required	Enter PrivateLink Endpoint name Enter 3 ~ 20 characters using English letters and numbers
     Description	Optional	Enter additional information or description within 50 characters
     PrivateLink Service ID	Required	Enter the ID of the PrivateLink Service to connect Check the Service ID with the PrivateLink Service provider in advance, and after creating the Endpoint, provide the Endpoint ID to the provider Enter 3 ~ 60 characters using English letters and numbers

     Table. PrivateLink Endpoint creation information input items

4. When information entry and selection is complete, click the Confirm button.

5. Check the message in the notification popup window, then click the Confirm button.

   • Once creation is complete, verify the created resource in the PrivateLink Endpoint list.
   • To delete a PrivateLink Endpoint, select the resource to delete from the list and click the Delete button.

Viewing PrivateLink Endpoint Details

You can view and modify the complete resource list and detailed information of PrivateLink Endpoint. The PrivateLink Endpoint Details page consists of Details and Operation History tabs.

To view detailed information of an API service, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the PrivateLink Endpoint menu on the Service Home page. This will take you to the PrivateLink Endpoint List page.
3. Click the resource for which you want to view detailed information on the PrivateLink Endpoint List page. This will take you to the PrivateLink Endpoint Details page.
   • The PrivateLink Endpoint Details page displays status information and additional feature information, and consists of Details and Operation History tabs.

     Item	Description
     Status Display	Status of PrivateLink Endpoint Requesting: Connection request/approval pending, Cancel Request button displayed Active: Creation complete, operating Creating: Being created Deleting: Being deleted Disconnected: Connection blocked Rejected: Connection rejected, Request Approval Again button displayed Error: Error occurred Canceled: Connection request canceled, Request Approval Again button displayed
     Cancel Request	Request connection cancellation
     Request Approval Again	Request connection again when connection request is in canceled status

     Table. PrivateLink Endpoint status information and additional features

Details

On the PrivateLink Endpoint Details page, you can view detailed information of the selected resource.

Operation History

On the PrivateLink Endpoint Details page, you can view the operation history of the selected resource.

Creating a Resource

A resource is a logical unit representing a specific endpoint (URI path) within an API. Each resource can be organized in a tree structure and can have multiple HTTP methods.

To create a resource, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the API Gateway > Resource menu on the Service Home page. This will take you to the Resource page.

3. Click the Create Resource button on the Resource page. This will take you to the Create Resource popup window.

   • Enter or select the required information.

     Item	Required	Description
     Resource Name	Required	Enter resource name Start with lowercase English letters and enter 3 ~ 50 characters using lowercase letters, numbers, and special characters (-{}) When using braces, only the format {character} is allowed and cannot be empty
     Resource Path	Required	Select the path selected from the resource menu tree

     Table. Resource creation information input items

4. When information entry and selection is complete, click the Confirm button.

5. Check the message in the notification popup window, then click the Confirm button.

   • Once creation is complete, verify the created resource in the resource list.
   • To delete a resource, select the resource to delete from the list and click the Delete button.

Creating a Method

A method defines HTTP actions (e.g., GET, POST, PUT, DELETE, etc.) that can be performed on each resource. Each method is integrated with a specific backend to process actual data or execute functions.

To create a method, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the API Gateway > Resource menu on the Service Home page. This will take you to the Resource page.

3. Click the Create Method button on the Resource page. This will take you to the Create Method popup window.

   • Enter or select the required information.

     Item	Required	Description
     Method Type	Required	Select method type Already created values are not displayed in the list. When ANY is selected, all types of methods are created
     Integration Type	Required	Select endpoint type Select from HTTP, Cloud Function, PrivateLink
     Endpoint URL	Required	Enter endpoint URL when selecting HTTP type An endpoint is a unique URL used by clients to access the API. Separate endpoints are created for each stage. Various types such as Regional, Edge-Optimized, Private, etc. Must be a valid URL starting with http:// or https://, and enter within 500 characters using English letters and special characters ($-_.+!*’:(){}/)
     Endpoint	Required	Select endpoint when selecting Cloud Function type Region is provided as the current region and cannot be changed
     URL Query String Parameters	Optional	Check Use and then enter Name Enter using English letters, numbers, and special characters (_)
     HTTP Request Headers	Optional	Check Use and then enter Name Enter using English letters, numbers, and special characters (-)
     API Key Usage	Optional	Check Use to limit usage through usage policy

     Table. Method creation information input items

4. When information entry and selection is complete, click the Save button.

5. Check the message in the notification popup window, then click the Confirm button.

   • Once creation is complete, verify the created resource in the method list.
   • To delete a method, select the resource to delete from the list and click the Delete button.

Deploying an API

To reflect an API under development to the actual service environment, API deployment is required.

To deploy a created API, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the API Gateway > Resource menu on the Service Home page. This will take you to the Resource page.

3. Click the Deploy API button on the Resource page. This will take you to the Deploy API popup window.

   • Enter or select the required information.

     Item	Required	Description
     Stage	Required	Select stage to deploy API New Stage: Deploy by creating a new stage None Stage: Deploy without selecting a stage
     Stage Name	Required	When selecting New Stage, enter new stage name Start with lowercase English letters, do not end with special characters (-), and enter 3 ~ 30 characters using lowercase letters, numbers, and special characters (-)
     Deployment Description	Optional	Enter additional information or description about API deployment within 50 characters

     Table. API deployment information input items

4. When information entry and selection is complete, click the Deploy button.

5. Check the message in the notification popup window, then click the Confirm button.

Creating a Stage

A stage is a named reference to a specific point in time (snapshot) of an API deployment, distinguishing environments for each lifecycle of the API such as development (dev), test (test), production (prod), etc. Each stage has a unique URL, and separate settings can be made per environment such as caching, logging, throttling, and stage variables. Through stages, various operational scenarios such as Canary release, environment-specific settings, and traffic separation are supported.

To create a stage to deploy an API, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the API Gateway > Stage menu on the Service Home page. This will take you to the Stage page.

3. Click the Create Stage button on the Stage page. This will take you to the Create Stage popup window.

   • Enter or select the required information.

     Item	Required	Description
     Stage Name	Required	When selecting New Stage, enter new stage name Start with lowercase English letters, do not end with special characters (-), and enter 3 ~ 50 characters using lowercase letters, numbers, and special characters (-)
     Stage Description	Optional	Enter additional information or description about the stage within 100 characters
     API Deployment Version	Required	Select API version to deploy Start with lowercase English letters, do not end with special characters (-), and enter 3 ~ 50 characters using lowercase letters, numbers, and special characters (-)

     Table. Stage creation information input items

4. When information entry and selection is complete, click the Confirm button.

5. Check the message in the notification popup window, then click the Confirm button.

   • Once creation is complete, verify the created resource in the stage list.

Viewing Stage Details

You can view and modify the stage list and detailed information. The details page consists of Stage Details information and API Deployment Version Management, CORS, Usage Policy tabs.

To view detailed information of a stage, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API Gateway > Stage menu on the Service Home page. This will take you to the Stage page.
3. Click the resource for which you want to view detailed information in the stage list.
   • The Stage Details displays status information and additional feature information, and consists of API Deployment Version Management, CORS, and Usage Policy tabs.
   • To delete a stage, select the resource to delete from the list and click the Delete button.
   • To modify a stage, select the resource to modify from the list and click the Modify button.

Stage Details

On the Stage Details page, you can view detailed information of the selected resource.

API Deployment Version Management

On the API Deployment Version Management tab, you can view API deployment history.

CORS (Cross-Origin Resource Sharing)

On the CORS tab, you can view the CORS list.

Usage Policy

On the Usage Policy tab, you can view the usage policy connected to the stage.

Creating Authentication

JWT (JSON Web Token) is an open standard (RFC 7519) used for user authentication. JWT is a claim-based web token that stores information about the user in an encrypted token using JSON format.

To create a JWT, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the API Gateway > Authentication menu on the Service Home page. This will take you to the Authentication List page.

3. Click the Create JSON Web Token button on the Authentication List page. This will take you to the Create JSON Web Token popup window.

   • Enter or select the required information.

     Item	Required	Description
     JWT Name	Required	Enter token name Start with lowercase English letters, do not end with special characters (-), and enter 3 ~ 50 characters using lowercase letters, numbers, and special characters (-)
     Stage to Connect	Optional	Check Use and then select a stage

     Table. Authentication creation information input items

4. When information entry and selection is complete, click the Confirm button.

5. Check the message in the notification popup window, then click the Confirm button. This will take you to the Access Token notification popup window.

   • Tokens can only be viewed in the Access Token notification popup window. If necessary, download the Access Token file.

6. Check the message in the Access Token notification popup window, then click the Confirm button.

   • Once creation is complete, verify the created resource in the authentication list.
   • To delete a token, select the resource to delete from the list and click the Delete button.
   • To modify a token, select Modify from the context menu of the resource to be modified.

Creating Access Control

You can add access allowed IPs so that API calls are made only from specific IPs when calling an API.

To create an access control, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.

2. Click the API Gateway > Access Control menu on the Service Home page. This will take you to the Access Control List page.

3. Click the Create Access Control button on the Access Control List page. This will take you to the Create Access Control popup window.

   • Enter or select the required information.

     Item	Required	Description
     Access Control Name	Required	Enter access control name Start with lowercase English letters, do not end with special characters (-), and enter 3 ~ 50 characters using lowercase letters, numbers, and special characters (-)
     Public Access Allowed IP	Required	Enter IP to allow access Enter up to 100 using ‘,’
     Stage to Connect	Optional	Check Use and then select a stage
     Description	Optional	Enter additional information or description about access control within 50 characters

     Table. Access control creation information input items

4. When information entry and selection is complete, click the Confirm button.

5. Check the message in the notification popup window, then click the Confirm button.

   • Once creation is complete, verify the created resource in the access control list.
   • To delete the access control list, select the resource to delete from the list and click the Delete button. The Default access control cannot be deleted.
   • To modify an access control, select Modify from the context menu of the resource to be modified.

Terminating an API

You can reduce operating costs by terminating services that are not in use. However, since terminating a service may immediately stop the operating service, you should proceed with termination after fully considering the impact of service interruption.

To terminate an API, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API menu on the Service Home page. This will take you to the API List page.
3. Select the resource to terminate on the API List page and click the Terminate Service button.
4. When termination is complete, verify that the resource has been terminated on the API List page.

Using Report

You can check API traffic, performance, and error status.

To use Report, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API Gateway > Report menu on the Service Home page. This will take you to the Report page.
   • Enter or select the required information.

3. When information entry and selection is complete, you can view Report information.

Creating a Usage Policy

Usage policies are established to ensure efficient distribution of server resources, secure service stability, and prevent unnecessary traffic and abuse.

To create a usage policy, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API Gateway > Usage Policy menu on the Service Home page. This will take you to the Usage Policy page.
3. Click the Create Usage Policy button on the Usage Policy page. This will take you to the Create Usage Policy page.
   • Enter or select the required information.

4. When information entry and selection is complete, click the Complete button.
5. Check the message in the notification popup window, then click the Confirm button.
   • Once creation is complete, verify the created resource in the usage policy list.

Creating an API Key

API Keys are used to identify which user or application is calling an API. They are mainly used to limit usage through usage policies.

To create an API Key, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API Gateway > Usage Policy menu on the Service Home page. This will take you to the Usage Policy page.
3. Click the usage policy in the list. This will take you to the Usage Policy Details page.
4. Click the Create API Key button on the Usage Policy Details page. This will take you to the Add API Key popup window.
   • Enter or select the required information.

4. When information entry and selection is complete, click the Confirm button.
5. Check the message in the notification popup window, then click the Confirm button.
   • Once creation is complete, verify the created resource on the Usage Policy Details page.

Creating a Resource Policy

You can block unauthorized access from the source through resource-based policies and enhance the security level of the service.

To create a resource policy, follow these steps:

1. Click the All Services > Application Service > API Gateway menu. This will take you to the API Gateway Service Home page.
2. Click the API Gateway > Resource Policy menu on the Service Home page. This will take you to the Resource Policy page.
3. Click the Create Resource Policy button on the Resource Policy page. This will take you to the Create Resource Policy page.
   • Enter or select the required information in the Service Information section.

4. When information entry and selection is complete, click the Complete button.
5. Check the message in the notification popup window, then click the Confirm button.
   • Once creation is complete, you can view, modify, or delete the resource policy.