기획자가 알아야 할 수준의 API 기본 개념

API는 Application Programming Interface의 약자로 서로 다른 소프트웨어 시스템들이 상호 작용할 수 있도록 돕는 인터페이스입니다. 예를 들어, 모바일 앱이 서버와 데이터를 주고받거나, 외부 서비스와 연동되는 기능을 구현할 때 API를 사용합니다. 간단히 말해, API는 소프트웨어 간의 커뮤니케이션을 가능하게 하는 '언어'입니다.

 

이러한 API는 외부에 공개가 되어 사용되기도 합니다. 이를 오픈 API라 부릅니다. 이는 누구나 사용할 수 있도록 공개된 API를 의미하며 결제 시스템, 지도 서비스, 데이터 분석 등의 다양한 분야에서 활용될 수 있습니다.

 

PM이 API를 이해해야 하는 이유

API는 제품 기획 및 설계를 하는데 도움이 됩니다. 따라서 PM이 API의 기본 개념을 이해하고 있으면 개발자와의 커뮤니케이션이 원활해집니다. 기술적인 용어와 개념을 이해함으로써 개발 요구 사항을 정확히 전달하고, 개발 진행 상황을 효과적으로 파악할 수 있기 때문입니다. 그렇게 되면 자연스럽게 문제가 발생했을 때 그를 더 빨리 인지하고 해결책을 제시할 수도 있습니다.

 

API에서 자주 사용되는 용어

API문서를 자연스럽게 읽고 이해할 수 있는 능력이 생긴다면 API를 잘 이해했다고 할 수 있습니다.  API에서 자주 사용되는 용어에 대해 정리해 보았습니다.

 

Endpoint(엔드포인트)

API가 접근할 수 있는 하나의 URL 주소를 의미합니다. 예를 들어 'https//api.examle.com/users'는 사용자의 정보를 가져오는 앤드포인트일 수 있습니다.

 

Request(요청)

클라이언트가 서버에 데이터를 요청하는 행위입니다. API 요청은 주로 HTTP 메서드를 사용합니다.

 

Response(응답)

서버가 클라이언트의 요청에 대해 반환하는 데이터입니다. 이는 주로 JSON 또는 XML 형식으로 이루어져 있습니다.

 

HTTP Medthod(HTTP 메서드)

API 요청의 종류를 나타냅니다. 주료 HTTP메서드는 다음이 포함됩니다.

- GET : 서버에서 데이터를 가져오는 요청

- POST : 서버에 데이터를 보내는 요청

- PUT : 서버에 있는 데이터를 업데이트하는 요청

- DELETE : 서버에 있는 데이터를 삭제하는 요청

 

Status Code(상태 코드)

서버가 클라이언트의 요청에 대해 응답할 때 사용하는 코드로, 요청의 성공 여부를 나타냅니다.

- 200 OK : 요청이 성공적으로 처리됨

- 201 Created : 새로운 리소스가 성공적으로 생성됨

- 400 Bad Request : 잘못된 요청

- 401 Unauthorized : 인증되지 않은 요청

- 404 Not Found : 요청한 리소스를 찾을 수 없음

- 500 Internal Server Error : 서버 내부오류

 

Header(헤더)

요청이나 응답의 부가 정보를 포함하는 부분입니다. 예를 들어, 인증 토큰, 데이터 형식 등을 지정할 수 있습니다.

 

Body(본문)

요청 또는 응답의 실제 데이터가 포함되는 부분입니다. 주로 JSON 형식으로 데이터를 전송합니다.

 

Authentication(인증)

API를 사용하기 전에 사용자의 신원을 확인하는 과정입니다. 일반적으로 API 키, OAuth 토큰 등을 사용하여 인증합니다.

 

Rate Limiting(요청 제한)

일정 시간 내에 API 요청 횟수를 제한하는 기능으로, 서버 과부하를 방지합니다.

 

API Key(API 키)

API에 접근할 수 있는 권한을 부여하는 고유한 키입니다. 이를 통해 인증과 요청 추적이 가능합니다.

---

상황에 따라 PM이 API문서를 작성에 참여하는 경우도 있습니다. 그전에 기본적인 개념에 대해서 먼저 이해를 하면 좋을 것 같습니다.