How-to guides

Through the Samsung Cloud Platform Console, users can enter the required information for the API Gateway service and select detailed options to create the service.

Create API

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

You can create an API in the Samsung Cloud Platform Console and use it.

To create an API, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the Create API button. Navigate to the Create API page.
3. On the API creation page, enter the information required to create a service and select detailed options.
   • Select the required information in the Service Information Input area.

     Category	Required	Detailed description
     API name	Required	Enter API name must start with a lowercase English letter and must not end with a special character (-), using lowercase letters, numbers, and special characters (-) to enter 3 ~ 50 characters
     How to create an API	Required	Select API creation method Select Create new or Clone existing API
     API to clone	Required	If you select Existing API Replication as the API creation method, choose from the APIs that have already been created.
     Explanation	Selection	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 the API so it can only be requested privately from other VPCs Selecting Private enables JWT activation

     Table. API Service Information Input Items

• In the Additional Information Input area, enter or select the required information.

  Category	Required status	Detailed description
  tag	Selection	Add Tag Click the Add Tag button to create and add a new tag, or to add an existing tag. You can add up to 50 tags. The newly added tags are applied after the service creation is completed.

  Table. API additional information input fields

4. Summary Check the detailed information and estimated billing amount generated in the panel, and click the Complete button.
   • When creation is complete, check the created resource on the API List page.

Check API detailed information

You can view and edit the complete list of resources and detailed information for the API service. The API Details page consists of Details, Tags, Activity Log tabs.

To view detailed information about the API service, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API menu. You will be taken to the API List page.
3. On the API List page, click the resource you want to view detailed information for. You will be taken to the API Details page.
   • API Details page displays status information and additional feature information, and consists of Details, Tags, Activity History tabs.

     Category	Detailed description
     Status display	Status of the API created by the user Creating: API creation in progress Active: API operating normally Deleting: API deletion in progress Error: API is in an unavailable state due to an internal error
     Service termination	Cancel service button

     Table. API status information and additional features

Detailed Information

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

Connection Management

Connection Management page lets you manage connection requests for the PrivateLink Service for API Gateway.

tag

API Details page lets you view the tag information of the selected resource, and add, modify, or delete it.

Job History

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

Integrating PrivateLink Service

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

Create a PrivateLink service for API Gateway

When creating an API, select the endpoint type as Private. This allows you to expose the API for private access from other VPCs or services.

Create PrivateLink Endpoint

You can create it to use the Entry Point for accessing other PrivateLinks in the API Gateway service.

To create a PrivateLink Endpoint, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.

2. Click the PrivateLink Endpoint menu on the Service Home page. You will be taken to the PrivateLink Endpoint List page.

3. On the PrivateLink Endpoint List page, click the PrivateLink Endpoint Create button. You will be taken to the PrivateLink Endpoint Create page.

   • Enter or select the required information.

     Category	Required	Detailed description
     PrivateLink Endpoint name	Required	Enter PrivateLink Endpoint name Enter using English letters and numbers, 3 to 20 characters
     description	Selection	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 using letters and numbers, 3 to 60 characters

     Table. PrivateLink Endpoint creation information input items

4. When data entry or selection is complete, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button.

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

Check detailed information of PrivateLink Endpoint

You can view and edit the full list of resources and detailed information for a PrivateLink Endpoint. The PrivateLink Endpoint Details page consists of Detailed Information and Operation History tabs.

To view detailed information about the API service, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. Click the PrivateLink Endpoint menu on the Service Home page. You will be taken to the PrivateLink Endpoint List page.
3. On the PrivateLink Endpoint List page, click the resource to view detailed information. You will be taken to the PrivateLink Endpoint Details page.
   • PrivateLink Endpoint Details page displays status information and additional feature information, and consists of Details and Activity Log tabs.

     Category	Detailed description
     Status display	PrivateLink Endpoint status Requesting: connection request pending approval, Cancel request button displayed Active: creation completed, operating Creating: in progress Deleting: deletion in progress Disconnected: connection blocked Rejected: connection denied, Request re-approval button displayed Error: error occurred Canceled: connection request canceled, Request re-approval button displayed
     Cancel request	Cancel connection request
     Re-request approval	Re-requesting a connection after the original request was canceled

     Table. PrivateLink Endpoint status information and additional features

Detailed Information

PrivateLink Endpoint Details page lets you view detailed information of the selected resource.

Job History

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

Create Resource

A resource is a logical unit that represents 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. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Resources menu. Navigate to the Resources page.

3. Click the Create Resource button on the Resource page. You will be taken to the Create Resource popup.

   • Enter or select the required information.

     Category	Required	Detailed description
     resource name	Required	Enter the resource name It must start with a lowercase English letter and be 3 to 50 characters using lowercase letters, numbers, and special characters (-{}) When using braces, only the format {character} is allowed and it cannot be left empty
     resource path	Required	Select the path chosen in the resource menu tree

     Table. Resource creation information input fields

4. Click the Confirm button after completing data entry and selection.

5. After checking the message in the notification popup, 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.

Create Method

Methods define the 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 functionality.

To create a method, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Resources menu. You will be taken to the Resources page.

3. Click the Create Method button on the Resource page. It navigates to the Create Method popup.

   • Enter or select the required information.

     Category	Required	Detailed description
     Method type	Required	Select method type The generated value is not displayed in the list. Selecting ANY creates methods of all types.
     Integration type	Required	Select endpoint type Select from HTTP, Cloud Function, PrivateLink
     Endpoint URL	Required	Enter the endpoint URL when HTTP type is selected The endpoint is a unique URL that the client uses to access the API. Create a separate endpoint for each stage. Various types such as Regional, Edge-Optimized, Private, etc. It must be a valid URL starting with http:// or https://, and you must enter it within 500 characters using English letters and special characters ($-_.+!*’:(){}/)
     endpoint	Required	When Cloud Function type is selected, choose the endpoint The region is provided as the current region and cannot be changed
     URL query string parameter	Selection	After checking use, enter name using English letters, numbers, and special characters(_)
     HTTP request header	Selection	After checking use, enter name using English letters, numbers, and special characters (-) to input
     Whether to use API Key	Selection	To limit usage through the usage policy, check Use

     Table. Method creation information input fields

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

5. After checking the message in the notification popup, click the Confirm button.

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

Deploy API

To apply a developing API to the live service environment, API deployment is required.

To deploy the generated API, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Resources menu. You will be taken to the Resources page.

3. Click the API Deployment button on the Resources page. It opens the API Deployment popup.

   • Enter or select the required information.

     Category	Required	Detailed description
     Stage	Required	Select the stage to deploy the API New Stage: Create a new stage and deploy None Stage: Deploy without selecting a stage
     Stage name	Required	When New Stage is selected, enter a new stage name that starts with a lowercase English letter and does not end with a special character (-), using lowercase letters, numbers, and special characters (-) for 3 to 30 characters
     Deployment description	Selection	Enter up to 50 characters describing API deployment.

     Table. API deployment information input fields

4. Click the Deploy button once information entry and selection are complete.

5. After checking the message in the notification popup, click the Confirm button.

Create Stage

The stage is a named reference to a specific point in time (snapshot) of an API deployment, distinguishing environments in the API lifecycle such as development (dev), testing (test), and production (prod). Each stage has its own unique URL, and separate settings can be configured per environment for caching, logging, throttling, stage variables, and so on. Stages support various operational scenarios, including Canary releases, environment-specific configurations, and traffic segregation.

To create a stage for deploying the API, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Stage menu. You will be taken to the Stage page.

3. On the Stage page, click the Create Stage button. You will be taken to the Create Stage popup.

   • Enter or select the required information.

     Category	Required	Detailed description
     Stage name	Required	When New Stage is selected, enter a new stage name that starts with a lowercase English letter and does not end with a special character (-), using lowercase letters, numbers, and special characters (-) with a length of 3 ~ 50 characters
     Stage description	Selection	Enter additional information or description about the stage within 100 characters.
     API deployment version	Required	Select the API version to deploy Must start with a lowercase English letter and must not end with a special character (-), using lowercase letters, numbers, and special characters (-) enter 3 to 50 characters

     Table. Stage creation information input fields

4. Click the Confirm button after completing data entry and selection.

5. After checking the message in the notification popup, click the Confirm button.

   • Once creation is complete, check the created resources in the stage list.

Check stage detailed information

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

To view the detailed information of the stage, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. From the Service Home page, click the API Gateway > Stage menu. You will be taken to the Stage page.
3. Click the resource to view detailed information in the stage list.
   • Stage Details displays status information and additional feature information, and consists of API Deployment Version Management, CORS, Usage Policy tabs.
   • To delete a stage, select the resource to delete from the list and click the Delete button.
   • To edit a stage, select the resource to modify from the list and click the Edit button.

Stage Details

You can view detailed information of the selected resource on the Stage Details page.

API deployment version management

API deployment version management tab allows you to view the API deployment history.

CORS (Cross-Origin Resource Sharing)

You can view the CORS list in the CORS tab.

Usage Policy

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

Create authentication

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

To generate a JWT, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.

2. On the Service Home page, click the API Gateway > Authentication menu. You will be taken to the Authentication List page.

3. On the Authentication List page, click the Create JSON Web Token button. You will be taken to the Create JSON Web Token popup.

   • Enter or select the required information.

     Category	Required	Detailed description
     JWT name	Required	Enter token name that starts with a lowercase English letter and does not end with a special character (-), using lowercase letters, numbers, and special characters (-) to input 3 to 50 characters
     Stage to connect	Selection	After checking Use, select the stage

     Table. Authentication creation information input items

4. After entering information and making selections, click the Confirm button.

5. After reviewing the message in the notification popup, click the Confirm button. Navigate to the Access Token notification popup.

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

6. Access Token After checking the message in the notification popup, click the Confirm button.

   • After creation is complete, check 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 edit a token, select Edit from the context menu of the resource you want to modify.

Create Access Control

You can add an allowed IP to restrict API calls to a specific IP address.

To create an access control, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.

2. From the Service Home page, click the API Gateway > Access Control menu. Navigate to the Access Control List page.

3. Access Control List page, click the Create Access Control button. You will be taken to the Create Access Control popup.

   • Enter or select the required information.

     Category	Required	Detailed description
     Access control name	Required	Enter the access control name that starts with a lowercase English letter, does not end with a special character (-), and uses lowercase letters, numbers, and special characters (-) within 3 to 50 characters
     Public access allowed IP	Required	Enter IP addresses to allow access ’,’ you can input up to 100 using ‘,’
     Stage to connect	Selection	After checking Use, select the stage
     description	Selection	Enter additional information or description about access control within 50 characters.

     Table. Access control creation information input fields

4. After entering information and making selections, click the Confirm button.

5. After checking the message in the notification popup, click the Confirm button.

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

Terminate API

You can cancel the unused service to reduce operating costs. However, canceling the service may cause the running service to stop immediately, so you should consider the impact of service interruption thoroughly before proceeding with the cancellation.

To cancel the API, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API menu. You will be taken to the API List page.
3. On the API List page, select the resource to cancel and click the Cancel Service button.
4. When the termination is complete, verify on the API List page that the resource has been terminated.

Using Report

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

To use the Report, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Report menu. You will be taken to the Report page.
   • Enter or select the required information.

3. After entering the information and making selections, you can view the Report information.

Create Usage Policy

The usage policy is established to ensure efficient allocation of server resources, maintain service stability, prevent unnecessary traffic, and avoid misuse.

To create a usage policy, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Usage Policy menu. You will be taken to the Usage Policy page.
3. On the Usage Policy page, click the Create Usage Policy button. You will be taken to the Create Usage Policy page.
   • Enter or select the required information.

4. When the information entry and selection are complete, click the Complete button.
5. After checking the message in the notification popup, click the Confirm button.
   • Once creation is complete, check the created resource in the usage policy list.

Create API Key

An API key is used to identify which user or app is calling the API. It is primarily used to limit usage according to usage policies.

To create an API Key, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Usage Policy menu. You will be taken to the Usage Policy page.
3. In the list, click the usage policy. It navigates to the Usage Policy Details page.
4. On the Usage Policy Details page, click the Create API Key button. You will be taken to the Add API Key popup.
   • Enter or select the required information.

4. Click the Confirm button after completing data entry and selection.
5. After checking the message in the notification popup, click the Confirm button.
   • When creation is complete, check the created resources on the Usage Policy Details page.

Create Resource Policy

You can fundamentally block unauthorized access with resource-based policies and increase the service’s security level.

To create a resource policy, follow these steps.

1. Click the All Services > Application Service > API Gateway menu. Navigate to the Service Home page of API Gateway.
2. On the Service Home page, click the API Gateway > Resource Policy menu. You will be taken to the Resource Policy page.
3. On the Resource Policy page, click the Create Resource Policy button. You will be taken to the Create Resource Policy page.
   • Enter or select the required information in the Service Information Input area.

4. Click the Complete button after entering information and making selections.
5. After checking the message in the notification popup, click the Confirm button.
   • Once creation is complete, you can view, modify, or delete the resource policy.