- Print
- PDF
API Gateway overview
- Print
- PDF
Available in Classic and VPC
API Gateway is a service that allows you to conveniently perform all tasks related to Application Programming Interface (API) calls. It provides various management features for stable API execution and a dashboard for real-time monitoring of API usage.
API Gateway features
API Gateway provides the following features:
Product management
- Group multiple APIs and manage them as a product
- Provides a call domain for each product, allowing other users on NAVER Cloud Platform to use the APIs through public settings
- Identify user applications or limit usage with the API key using the product
API management
- Define REST APIs, related resources, and methods, and set authentication methods
- Manage predefined API specifications and overview that API users can refer to
- Operate multiple versions of the same API using stage and version control features
- Build settings including stage-specific cache use, throttling policy, and IP ACL to stabilize backend service
Usage Plan management
- Set request rate and request quota to limit usage of API users
API key management
- Issue API key to use API provided by other users or NAVER Cloud Platform
- Subscribe to services by API key and check usage for each stage
API usage monitoring
- Monitor API usage collected in real-time through the dashboard
- Monitor performance metrics such as the number of API calls, success rates, and average response times by hour, day, or month
API Gateway user guide
API Gateway is available in Korea, U.S., Singapore, Japan, and Germany Regions, and the same service is provided in each Region. This guide will walk you through the information you need to start using API Gateway.
- API Gateway overview: describes features, user guides, and related resources
- API Gateway prerequisites: view supported environments, limitations, and pricing information
- API Gateway quickstart: guides you through the entire process step-by-step
- Getting started with API Gateway: learn how to manage subscriptions and create a product from NAVER Cloud Platform console
- Using API Gateway: learn how to access API Gateway
- My Products: learn how to manage products, APIs, catalogs, documents, and API keys
- Published APIs: learn how to view API documents shared by other users and subscribe to them
- Usage Plans: learn how to create, manage, and delete usage plans to limit API usage
- API Keys: learn how to create, manage, and delete API keys for API user authentication
- Authorizers: learn how to create, edit, test, and delete authorizers to protect APIs, along with usage examples
- Client Certificates: learn how to create, edit, test, delete, and use client certificates
- Dashboard: learn how to use the dashboard to monitor API usage
- API Gateway permissions management: manage accounts using NAVER Cloud Platform's Sub Account
- API Gateway glossary: familiarize yourself with key terms and definitions
- API Gateway troubleshooting: troubleshoot any issues with API Gateway
- API Gateway release notes: see documentation history for API Gateway user guides
API Gateway related resources
NAVER Cloud Platform provides the user guide and other various resources to help our customers understand API Gateway better. If you are considering to introduce API Gateway, or if you are a developer or a marketer who needs detailed information in establishing your data-related policies, make good use of the following resources.
Improvement in comprehension and usage methods for API Gateway
- API Gateway API guide: how to use API for API Gateway developers
- Ncloud user environment guide: a user guide on the VPC environment and supported features
- Calling business logics using API Gateway and Cloud Functions: how to call business logics using API Gateway and Cloud Functions
- Introduction to API Gateway blog: introduction to API Gateway in NAVER Cloud Platform official blog
- Introduction to pricing, characteristics, and detailed features: summary of API Gateway's pricing system, characteristics, and detailed features
- Latest service news: latest news related to API Gateway
- FAQs: frequently asked questions from API Gateway users
- Contact us: send direct inquiries in case of any unresolved questions that aren't answered by the user guide
User guides for related services required for the use of API Gateway
- File Safer user guide: how to use File Safer to check for malicious content in files and outbound links provided by your service
- Key Management Service user guide: how to use Key Management Service to manage and protect keys used to encrypt critical customer information
- Cloud Functions user guide: how to use Cloud Functions that provide actions which can be connected with API Gateway
- Sub Account user guide: how to use Sub Account, which aids in the management of API Gateway and its administration managing permissions