{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"63d0c8c9-b3ab-4d16-8d55-75ca79a223e3","name":"더존 빵돌이 공식 API 문서 | 개발자 가이드","description":"\n\n## 1\\. 개요\n\n더존 빵돌이 API는 **일반 사용자**와 **관리자**를 대상으로 하는 **RESTful API**로, 더존 빵돌이 관련 데이터를 효율적으로 관리하고 활용할 수 있도록 설계되었습니다. API는 사용 목적과 대상 사용자에 따라 두 가지로 구분됩니다.\n\n### 공용 API (Common API)\n\n- **대상 사용자**: 일반 사용자 및 관리자\n \n\n#### 주요 기능\n\n- **데이터 조회**: 서비스 이용을 위한 정보 제공 (예: 카페 메뉴 조회, 식단 확인, 통근 버스 확인 등)\n \n- **사용자 요청 처리**: 카페 메뉴 추가 등\n \n- **엔드포인트 시작점**: /api\n \n\n### 관리자 전용 API (Admin API)\n\n- **대상 사용자**: 관리자\n \n\n#### 주요 기능\n\n- **데이터 관리**: 서비스 데이터의 추가, 수정, 삭제\n \n- **통계 및 리포트 확인**: 서비스 운영을 위한 통계 자료 제공\n \n- **설정 관리**: 서비스 설정 및 구성 변경\n \n- **엔드포인트 시작점**: /api/admin\n \n\n## 2\\. 사용 가이드\n\n### HTTP 메서드\n\n- 표준 HTTP 메서드 **GET**, **POST**, **PUT**, **DELETE** 사용\n \n\n#### 특이 사항\n\n- **다중 삭제** 작업은 **POST** 메서드를 사용하며,\n \n- URI에 /delete 명시\n \n\n### 데이터 형식\n\n- 모든 요청 및 응답 데이터는 **JSON 형식**\n \n\n## 3\\. 오류 처리\n\n- API 사용 중 요청이 실패하면, 아래와 같은 일관된 JSON 형식의 오류 응답을 반환\n \n\n### 오류 응답 형식\n\n``` json\n{\n \"success\": false,\n \"error\": {\n \"code\": \"CA-2002\",\n \"message\": \"CafeCart must be ACTIVE\"\n }\n}\n\n ```\n\n- `success`: 요청 처리 성공 여부 (오류 시 항상 `false`)\n \n- `error.code`: 오류 상황 식별을 위한 코드\n \n- `error.message`: 클라이언트에게 전달되는 오류 설명 메시지\n \n\n### 오류 코드\n\n| 코드 | HTTP 상태 코드 | 오류 설명 |\n| --- | --- | --- |\n| VAL-0001 | 400 | 헤더 입력값 누락 또는 유효하지 않은 입력값입니다. |\n| VAL-0002 | 400 | 필드 입력값 누락 또는 유효하지 않은 입력값입니다. |\n| VAL-0003 | 400 | 필드 입력값 누락 또는 유효하지 않은 입력값입니다. |\n| CA-1001 | 404 | CafeMenu가 존재하지 않습니다. |\n| CA-2001 | 404 | CafeCart가 존재하지 않습니다. |\n| CA-2002 | 422 | CafeCart가 활성 상태가 아니므로 요청을 처리할 수 없습니다. |\n| CA-2003 | 409 | CafeCart와 CafeCartItem의 카페 위치가 달라 처리할 수 없습니다. |\n| CA-2004 | 403 | CafeCart 생성자와 일치하지 않습니다. |\n| CA-3001 | 404 | CafeCartItem이 존재하지 않습니다. |\n| CA-3002 | 403 | CafeCartItem 생성자와 일치하지 않습니다. |\n| SSE-1001 | 500 | SSE 이벤트 전송 중 서버 내부 오류가 발생했습니다. |\n| SSE-1002 | 403 | 클라이언트가 SSE 구독이 거부되었습니다. |\n| SSE-1003 | 408 | 장시간 유휴 상태로 인해 SSE 연결이 종료되었습니다. |\n| E-400 | 400 | 잘못된 요청입니다. (IllegalArgumentException 또는 BindException 발생 시) |\n| E-500 | 500 | 서버 내부에서 알 수 없는 오류가 발생했습니다. |\n\n모든 오류 응답은 이 표에 정의된 규칙을 따름","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31818010","team":6563699,"collectionId":"63d0c8c9-b3ab-4d16-8d55-75ca79a223e3","publishedId":"2sAY546yf4","public":true,"publicUrl":"https://api-docs.breadkun.com","privateUrl":"https://go.postman.co/documentation/31818010-63d0c8c9-b3ab-4d16-8d55-75ca79a223e3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"더존 빵돌이의 공식 API 문서 사이트입니다. API의 상세한 가이드와 예시를 제공합니다."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-11-21T09:00:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"더존 빵돌이의 공식 API 문서 사이트입니다. API의 상세한 가이드와 예시를 제공합니다."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c4e6758e2defe7f9411955cd61c479845b5ca67396b8890ce3345035b4b27912","favicon":"https://res.cloudinary.com/postman/image/upload/v1750266322/team/41311160997743f2863de6aa0b993e2d.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.breadkun.com/view/metadata/2sAY546yf4"}