API

Braillify 는 Node.js(Wasm for Web) 와 Python 그리고 Rust, .NET을 지원합니다.

모든 함수는 표현 방식만 다를 뿐 사용법과 함수명은 같습니다.

Node.js 함수	Python 함수	Rust 함수	C# 함수	설명
encode	Encode	encode	encode	문자열을 바이너리로 변환합니다.
translateToUnicode	translate_to_unicode	encode_to_unicode	EncodeToUnicode	문자열을 유니코드 점자로 변환합니다.
translateToBrailleFont	translate_to_braille_font	encode_to_braille_font	EncodeToBrailleFont	문자열을 점자 폰트로 변환합니다.

HTTP API

별도의 패키지 설치 없이 HTTP 요청만으로 점역을 이용할 수 있도록 공개 API 서버를 제공합니다.

Base URL	https://api.braillify.kr
Swagger UI	https://api.braillify.kr/docs
인증	불필요
요청 / 응답 포맷	application/json (UTF-8)

텍스트 점역 (GET)

쿼리 스트링으로 텍스트를 전달하여 점역합니다.

이름	타입	필수	설명
text	string	O	점역할 텍스트. 한글 / 영문 / 숫자 모두 지원합니다.

curl "https://api.braillify.kr/braille?text=안녕하세요"

텍스트 점역 (POST)

긴 문장이나 줄바꿈 / 특수문자를 안전하게 전달하려면 JSON 본문으로 요청합니다.

{
  "text": "안녕하세요"
}

필드	타입	필수	설명
text	string	O	점역할 텍스트. UTF-8 로 인코딩합니다.

curl -X POST "https://api.braillify.kr/braille" \
  -H "Content-Type: application/json" \
  -d '{"text":"안녕하세요"}'

응답 (200 OK)

{
  "text": "안녕하세요",
  "braille": "⠣⠉⠟⠚⠠⠝⠚⠠⠝⠝⠬",
  "length": 5
}

필드	타입	설명
text	string	입력한 원문 텍스트를 그대로 echo 합니다.
braille	string	점역 결과 (유니코드 점자 문자열).
length	integer	입력 문자열의 문자 개수 (uint32).

에러 응답

요청이 실패하면 다음 형태의 에러 객체를 반환합니다.

{
  "error": "too_long",
  "message": "text exceeds 2000 character limit"
}

HTTP 상태	error 코드	발생 상황	메시지
413 PAYLOAD_TOO_LARGE	too_long	입력 텍스트가 max_input_chars (기본 2000자) 를 초과한 경우.	text exceeds {max} character limit
429 TOO_MANY_REQUESTS	rate_limited	IP 당 rate limit (기본 60req / 60s) 을 초과한 경우.	rate limit exceeded - try again later
400 BAD_REQUEST	conversion_failed	braillify::encode_to_unicode 변환 자체가 실패한 경우.	braille conversion failed: {err}

응답 본문 스키마

{
  "error": "too_long",
  "message": "text exceeds 2000 character limit"
}

필드	타입	설명
error	string	에러 코드 (machine-readable).
message	string	사람이 읽을 수 있는 에러 메시지.