nachocode API 개요
🔔 최신화 일자: 2026-06-16
nachocode API는 nachocode 서비스의 기능을 활용할 수 있도록 다양한 API를 제공합니다.
이 문서는 API의 개요, 주요 기능, 사용 방법 및 응답 구조를 안내합니다.
문서 구조
nachocode API 문서는 아래와 같은 구조로 구성되어 있습니다.
-
개요
nachocode API의 주요 기능과 개념을 설명합니다. -
푸시 알림
nachocode 플랫폼에서 제공하는 푸시 알림 기능을 설명합니다. -
앱 유저
nachocode 플랫폼에서 제공하는 앱 유저 기능을 설명합니다. -
추가 예정 API
향후 nachocode에서 제공할 다양한 API에 대한 문서가 포함될 예정입니다.
지원 기능
nachocode API는 아래와 같은 기능을 제공합니다.
푸시 알림
nachocode 플랫폼의 푸시 알림 서비스를 활용하여 원하는 대상에게 메세지를 실시간으로 전달하거나, 토큰 또는 구독을 제어할 수 있습니다.
개인화 푸시 알림 API
-
유저 목록 형식 푸시 전송: 유저 목록으로 동일한 메시지를 일괄 전송합니다.
유저 목록 형식 푸시➡️ 유저 목록 형식 푸시 알림 API 보러가기
-
메세지 목록 형식 푸시 전송: 각기 다른 유저에게 서로 다른 메시지를 전송합니다.
메세지 목록 형식 푸시➡️ 메세지 목록 형식 푸시 알림 API 보러가기
토픽 푸시 알림 API
-
토픽 푸시 전송: 특정 토픽(집단)에 대해 동일한 메세지를 일괄 전송합니다.
토픽 푸시➡️ 토픽 푸시 알림 API 보러가기
-
토픽 구독 제어: 유저 식별자를 통해 지정한 토픽을 구독, 또는 구독 해제시킵니다.
구독/ 구독 해제➡️ 토픽 구독 API 보러가기
➡️ 토픽 구독 해제 API 보러가기
전체 푸시 알림 API
-
전체 푸시 전송: 앱을 설치한 모든 유저에게 동일한 메세지를 일괄 전송합니다.
전체 푸시➡️ 전체 푸시 알림 API 보러가기
푸시 토큰 제어 API
-
푸시 토큰 제거: 유저 식별자를 통해 푸시 토큰을 등록 해제시킵니다.
토큰 제거➡️ 토큰 제거 API 보러가기
앱 유저
nachocode 플랫폼의 앱 유저 관리 서비스를 통해 광고성 푸시 알림 수신 여부 설정이 가능합니다.
앱 유저 관리 API
-
유저 제거: 유저 식별자를 통해 저장된 모든 유저 정보를 제거합니다.
회원 탈퇴➡️ 회원 탈퇴 API 보러가기
마케팅 동의 관리 API
-
광고성 푸시 알림 수신 동의 변경: 유저 식별자를 통해 마케팅 수신 여부를 변경합니다.
유저 마케팅 동의➡️ 마케팅 동의 API 보러가기
기본 사항
API 도메인
nachocode API의 기본 도메인은 다음과 같습니다.
- 도메인명:
https://app.nachocode.io - API 요청 주소의 형식:
https://app.nachocode.io/{path명}
API 호출
nachocode API는 반드시 서버 사이드에서 호출되어야 합니다.
Secret Key 유출이 의심될 경우, nachocode 대시보드에서 반드시 재발급 받아야합니다.
nachocode API는 모든 요청에서 인증 정보를 요구합니다. 다음 헤더를 반드시 포함해야 합니다.
| Header | Description |
|---|---|
x-api-key | nachocode 대시보드에서 발급받은 API 키 |
x-secret-key | nachocode 대시보드에서 발급받은 Secret 키 |
요청 헤더에 x-api-key와 x-secret-key를 포함하므로 클라이언트 사이드에서 호출 시 Secret Key가 노출될 위험이 있습니다.
API Key, Secret Key는 안전하고 원활한 API 통신을 위해 필요한 정보로
nachocode 대시보드 [앱 설정] > [개발자 설정] 탭에서 발급 가능합니다.
API 사용 방법
요청 형식
nachocode API는 JSON 형식의 요청 및 응답을 사용합니다.
HTTP 요청의 Header에는 인증 정보를 포함하며, Body에는 각 엔드포인트의 요구 사항에 맞는 데이터를 제공합니다.
요청 예시
curl -X POST https://app.nachocode.io/api/push/TARGET_ENDPOINT \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-secret-key: YOUR_SECRET_KEY" \
-d '{
"title": "TITLE_DATA",
"content": "CONTENT_DATA"
}'
마무리
nachocode API를 활용하여 푸시 알림을 손쉽게 전송하고, 앱 유저를 편하게 관리해보세요.
지속적인 업데이트를 통해 앞으로 더 많은 기능과 향상된 개발 경험을 제공할 예정입니다.
nachocode 팀은 여러분의 성공적인 프로젝트 구현을 위해 항상 도움을 준비하고 있습니다.
기술적인 질문이나 피드백이 있다면 언제든지 지원팀 이메일 support@nachocode.io로 문의를 보내주세요.