한뼘코딩

소개

한뼘코딩 개발자센터에 오신 것을 환영합니다. 한뼘코딩에서 제공하는 다양한 기능을 외부에서 활용할 수 있도록 API를 제공합니다. 이 문서를 통해 제공되는 API의 사용법을 확인하고, 여러분의 서비스에 한뼘코딩의 기능을 연동해 보세요.

API 목록

아래 링크를 통해 각 API의 상세 명세를 확인할 수 있습니다.

Rank API

사용자 랭킹 정보를 생성하고 조회합니다.

Program User API

사용자 프로그램 정보를 조회하고 관리합니다.

ABCDE API

ABCDE 관련 데이터를 다루는 API입니다.

API란 무엇인가요?

API는 서로 다른 프로그램들이 서로 이야기할 수 있게 해주는 특별한 통역사예요! 여러분이 만든 웹사이트나 앱이 한뼘코딩 서버와 데이터를 주고받을 수 있도록 도와주는 중간 다리 역할을 합니다.

쉬운 비유로 이해하기

도서관에서 책을 빌릴 때를 생각해보세요. 여러분(여러분의 프로그램)이 원하는 책 이름을 사서 선생님(API)에게 말하면, 사서 선생님이 책장(한뼘코딩 서버)에서 찾아서 빌려주시죠. API도 똑같아요! 여러분의 프로그램이 "랭킹 정보 주세요!"라고 요청하면, API가 한뼘코딩 서버의 데이터베이스에서 정보를 찾아서 여러분에게 전달해줍니다.

API가 할 수 있는 일들

📖 정보 가져오기: 한뼘코딩에 저장된 정보를 여러분의 프로그램에서 가져올 수 있어요. 마치 도서관에서 책을 빌리는 것처럼요!
✏️ 정보 저장하기: 여러분의 프로그램에서 한뼘코딩에 새로운 정보를 저장하거나 수정할 수 있어요.
🔗 기능 연결하기: 한뼘코딩의 멋진 기능들을 여러분의 웹사이트나 앱에 연결해서 사용할 수 있어요.

실제로 어떻게 사용하나요?

예를 들어, 여러분이 만든 웹사이트에 "각 애플리케이션 별 사용자 랭킹 TOP 10"을 보여주고 싶다고 생각해볼까요?

여러분의 웹사이트가 API에게 "랭킹 정보 주세요!"라고 요청해요
API가 한뼘코딩 서버에서 최신 랭킹 정보를 가져와요
가져온 정보를 여러분의 웹사이트에 보여줘요

알아두면 좋아요! API는 인터넷을 통해 통신하고, 정보는 주로 JSON이라는 특별한 형식으로 주고받아요. 하지만 걱정하지 마세요! API가 알아서 번역해주니까 여러분은 그냥 "정보 주세요!"라고만 요청하면 돼요! 😊

공통 안내

API 호출 기본

모든 API 호출은 HTTPS를 통해 이루어져야 합니다. API 요청 시 필요한 인증 정보나 파라미터는 각 API 명세에 따라 정확히 전송해야 합니다.

오류 코드

API 호출이 실패하면 HTTP 상태 코드와 함께 오류 메시지가 반환됩니다. 공통 오류 코드를 확인하여 예외 처리를 구현하세요. (자세한 내용은 추후 추가 예정)

CORS (Cross-Origin Resource Sharing)

한뼘코딩 API는 CORS 정책을 통해 외부 도메인에서의 API 호출을 제한합니다.

프로덕션 환경: 특정 도메인에서의 API 호출만 허용됩니다. 프로덕션 API를 사용하려면 사전에 도메인 등록이 필요할 수 있습니다.
로컬 개발 환경: 로컬호스트에서 API를 테스트할 때 CORS 오류가 발생할 수 있습니다. 이 경우 브라우저의 CORS 확장 프로그램을 사용하거나, 서버 측에서 프록시를 설정하여 해결할 수 있습니다.
권장 사항: 프로덕션 환경에서는 반드시 HTTPS를 사용하여 API를 호출하세요.

문서 이력

이 문서의 변경 사항을 확인할 수 있습니다.

2025년 11월 22일 - CORS 정책 안내 섹션 추가
2025년 11월 21일 - API 기본 개념 설명 섹션 추가
2024년 5월 21일 - 개발자센터 초기 문서 작성