<aside> 📄 이 문서는 클립스비엔씨 관리 포털의 API 정의 문서입니다. 문의사항은 아래 연락처로 연락주시면 도와드리겠습니다.

📩 이메일: [email protected]

📱 전화번호: 010-5789-7335

</aside>

ClipsBNC API Define Document

소개

이 문서는 ClipsBNC GroupWare API에 대한 가이드를 위해 작성되었습니다.

규칙

개발된 소스는 기본적으로 http 프로토콜을 사용하지만, 내부망 구현 요건에 따라 https로 전환 가능합니다.

기본 서버 세팅 포트는 8080입니다. ClipsBNC API는 페이지와 데이터베이스 리소스에 대한 GET, POST, PATCH, DELETE 요청을 통해 대부분 작업을 수행하는 등 가능한 한 RESTful 규칙을 따릅니다. 요청과 응답 본문은 JSON으로 인코딩됩니다.

상태 코드

HTTP 응답 코드는 일반적인 성공과 오류 클래스를 나타내는 데 사용됩니다. 아래 목록은 이번 서비스 구현에서 사용된 응답 코드 목록이며, 추후 상태 응답에 대한 추가 및 변경은 자유롭게 변경하시면 됩니다.

성공 코드

HTTP 상태 텍스트 설명
200 OK 성공적으로 처리된 요청
201 CREATED 리소스 생성에 성공한 요청