API 인증 키 발급 후 사용 가능합니다. 문서 링크를 참조해 주세요
헬스 체크
- key 발급 등 편의성을 위해 GUI 환경 별도 구축 예정입니다.
이 서비스는 한국어 비속어를 모두 검출하고 필터링할 수 있는 무료 API입니다.
- 경량 필터링 엔진: 정규식과 비속어 데이터베이스를 활용한 효율적인 필터링
- 고성능 검사:
아호코라식 알고리즘을 사용하여 빠르고, 정확한 비속어 검출 - 다양한 필터링 모드: 빠른 검사(QUICK), 일반 검사(NORMAL), 대체 검사(FILTER) 지원
- KISO 호환성: KISO 이용자 보호 시스템 API와 유사한 스펙으로 구현
이 API는 주로 다음과 같은 사용자를 위해 설계되었습니다:
- 포트폴리오나 취미 프로젝트를 개발하는 학생 및 개발자
- 비영리 서비스를 운영하는 소규모 단체
- 비용은 최소화하면서 기본적인 비속어 필터링이 필요한 웹사이트/앱
예산 제약 없이 상업적 서비스에 활용하실 경우에는 KISO 이용자 보호 시스템 API를 권장합니다(월 약 7만원).
이 서비스는 개인 서버로 운영되므로 가용성은 보장되지 않지만, 2025-05 기준 OCP 환경으로 이관하였습니다.
기본적인 비속어 필터링 기능을 무료로 제공하는 데 의의가 있습니다.
- 요청 URL:
POST https://api.profanity.kr-filter.com/api/v1/filter/ - headers
Content-Type: application/jsonorapplication/x-www-form-urlencodedaccept: application/jsonx-api-key: {API_KEY}- API_KEY는 제공되는 API_KEY를 사용해주세요.
- parameters:
- *
text: 검증할 문장 (예: "나쁜말") - *
mode:QUICK,NORMAL,FILTER중 하나 선택QUICK: 빠른 검사에 적합합니다.NORMAL: 일반적인 검사에 적합합니다.FILTER: 일반적인 검사후 비속어를*로 대체합니다.
callbackUrl: 비동기 처리시 결과를 받을 URL- * 기호가 붙은 파라미터는 필수 입력값입니다.
- *
- 요청에 대항 Http Status Code는 항상 200으로 응답됩니다.
- 응답 객체에서는 요청에 따라 변동적인
status.code에 응답 코드가 포함되어 있습니다. Status Code는 KISO 이용자 보호 시스템 API 서비스의 응답 코드를 참조하여 작성되었습니다.- 몇몇 상태 코드의 경우 실제로 구현이 되지 않은 상태 코드가 있습니다. 이는 추후에 구현될 예정입니다.(안될수도)
| Status Code | Description | Description |
|---|---|---|
| 2000 | OK | 요청이 정상적으로 처리된 상태를 의미합니다. |
| 2020 | Accepted | 비동기 요청이 정상적으로 접수된 상태를 의미합니다. |
| 4000 | Bad Request | 요청이 비정상적인 경우 입니다. 파라미터 누락,타입 오류등이 있습니다, 상세 내용을 참고하세요. |
| 4010 | Unauthorized | 요청을 인증할 API 키 값이 없는 경우 발생하는 오류 입니다. |
| 4030 | Forbidden | 서버에서 요청에 API 키값을 인식하였으나 해당 키가 적절한 권한을 가지지 않았다고 판정한 경우 발생합니다. |
| 4290 | Too Many Requests | 특정 클라이언트가 너무 많은 요청을 단위 시간 안에 보낸 경우에 이 응답이 리턴됩니다. |
| 5000 | Internal Server Error | 서버 측의 문제로 요청에 대한 처리가 불가능한 경우 오류가 발생하였음을 알리기 위해 본 코드를 사용합니다. |
{
"trackingId": "bee20667-aa5a-4d39-94f5-0f2dcbd51cac",
"status": {
"code": 2000,
"message": "Ok",
"description": "정상적으로 처리 되었습니다.",
"DetailDescription": ""
},
"detected": [
{
"length": 1,
"filteredWord": "나"
},
{
"length": 2,
"filteredWord": "나쁜"
},
{
"length": 3,
"filteredWord": "나쁜말"
},
{
"length": 2,
"filteredWord": "냐쁀"
}
],
"filtered": "*** 이런 개 ** 짓을 왜 하냐?, **, *",
"elapsed": "0.00007676 s / 0.07676 ms / 76.758 µs"
}| 날짜 | 개발 내용 | 상세 설명 |
|---|---|---|
| 2025-05-11 | 클라이언트 보고서 | 클라이언트별 일일 요청 통계 및 사용량 보고서 생성 기능 추가 |
| 2025-05-11 | 요청 모니터링 | 클라이언트별 API 요청 횟수 실시간 모니터링 및 제한 기능 개선 |
| 2025-02-15 | 비속어 동기화 | 중앙 DB에서 비속어 목록 실시간 업데이트 및 에이전트 동기화 기능 구현 |
| 2025-02-10 | 비속어 제안 API | 부적절한 비속어 신고 및 새로운 비속어 추가 제안을 위한 API 개발 |
| 2025-01-25 | 인증 시스템 적용 | API Key 기반 인증 시스템 구현 및 배포 완료 |
| 2025-01-03 | 인증 시스템 개발 | API Key 기반 인증 시스템 개발 착수 |
| 2024-12-30 | 특수문자 대응 | 특수문자, 유니코드 변형을 고려한 향상된 검증 로직 적용 |
| 2024-12-27 | 아키텍처 개선 | 클린 아키텍처 원칙 기반 코드 리팩토링 완료 |
| 2024-11-30 | 서버 이전 | 서버 물리적 이전 및 안정성 검증 완료 |
| 2024-07-06 | 비속어 DB 확장 | 120+ 추가 비속어 데이터베이스 확장 (누적 620+) |
| 2024-07-01 | 비속어 DB 확장 | 500+ 추가 비속어 데이터베이스 확장 |
| 2024-06-01 | 서비스 출시 | 초기 버전 서비스 공개 및 운영 시작 |
-
사용 목적: 이 서비스는 포트폴리오, 학습용 프로젝트, 비영리 서비스를 위해 제공됩니다. 상업적/영리 목적으로 활용하시려면 KISO 이용자 보호 시스템 API 서비스를 이용해 주세요.
-
가용성: 개인 서버로 운영되는 무료 서비스이므로 100% 가용성을 보장하지 않습니다. 서버 장애, 하드웨어 문제, 네트워크 이슈 등으로 일시적 중단이 발생할 수 있습니다.
-
성능 제한: 과도한 API 호출 시 서비스 품질 유지를 위해 요청 제한(rate limiting)이 적용될 수 있습니다.
-
API 변경: API 스펙은 개선을 위해 변경될 수 있습니다. 변경 시에는 이 문서를 통해 사전 공지할 예정입니다.
-
개인정보: API를 통해 전송되는 텍스트는 비속어 필터링 목적으로만 사용되며, 별도로 저장하지 않습니다. 단, 서비스 개선을 위한 기본적인 사용 통계는 수집될 수 있습니다.
-
책임 제한: 이 API의 결과에 의존하여 발생한 문제(필터링 실패, 잘못된 검출 등)에 대해 개발자는 법적 책임을 지지 않습니다.
이 서비스는 최대한 KISO 이용자 보호 시스템 API 서비스와 유사한 형태로 발전해 나갈 예정이지만, 무료 서비스로서의 한계가 있음을 양해해 주시기 바랍니다.
문의사항은 Issue로 등록하거나 이메일로 문의바랍니다.
📧 rlagusrl928@gmail.com |
