개발자로 등록하고 API 키 발급받기
문서 번역을 위한 RESTful API를 제공하며, 자동화된 번역 작업 관리, 용어집 기반 용어 일관성 유지, 지원 형식·언어·모델 조회 기능을 통해 원활한 번역 워크플로우 구축과 사용자 계정 관리를 지원합니다.
시작하기
시작하려면 개발자 신청을 하셔야 합니다.개발자로 지원하기
승인 후, 여러 개의 API 키를 생성하고 필요에 따라 각 API 요청에 적절한 API 키를 포함할 수 있습니다.
빠른 연동
기본 URL
https://shangyiai.com/api
인증 방식
Authorization: [yourSecretKey]
JSON 요청
파일 업로드 인터페이스를 제외하고, 기본적으로 POST JSON 요청을 사용하며, Content-Type은 application/json입니다.
파일 업로드
문서 번역 작업 생성은 multipart/form-data를 사용하며, file 필드에 번역할 파일을 전송합니다.
일반 오류 응답
요청이 실패할 때 인터페이스는 JSON을 반환하며, error 필드에는 고정된 영문 오류 정보가 포함됩니다. HTTP status code에 따라 오류를 우선 분기 처리하고, error 필드는 표시 또는 로그 기록에 사용할 것을 권장합니다.
{
"error": "Invalid API key."
}오류 상태 코드 규칙
모든 v1 API 오류 응답은 동일한 구조를 유지하므로, 다음 HTTP status code 규칙에 따라 처리하십시오.
- 400 Bad Request
- 필수 매개변수 누락, 잘못된 매개변수 형식 또는 열거형 값, 파일 업로드 누락, 업로드 저장 실패 또는 작업 처리 실패입니다.
- 401 Unauthorized
- API 키가 누락되었거나 잘못된 API 키입니다.
- 402 Payment Required
- 미리보기, 전체 번역 또는 텍스트 번역을 위한 크레딧 잔액이 부족합니다.
- 404 Not Found
- 작업 또는 용어집이 존재하지 않거나, 삭제되었거나, 현재 API 계정에 속하지 않거나, API를 통해 생성되지 않았습니다.
- 409 Conflict
- 현재 작업 상태에서는 요청한 작업이 허용되지 않습니다.
- 500 Internal Server Error
- 예상치 못한 서버 예외.응답 오류는 "Internal server error."로 고정됩니다.
권장 통합 프로세스
1. 작업 생성
파일을 업로드하고 번역 작업을 생성하며, taskId를 반환합니다.
2. 진행 상황 조회
작업 상태를 폴링하여 Completed, Terminated 또는 Cancelled가 될 때까지 확인합니다.
3. 결과 가져오기
번역 파일을 다운로드하거나 원문 및 번역문 JSON을 조회합니다.
4. 작업 관리
사용량 기반 전문 번역 결제, 작업 재시작, 텍스트 수정 또는 작업 삭제.