워크스페이스 사용자 지정 정보 설정¶
POST /api/v1/workspace/bind_info/set
개요¶
현재 워크스페이스의 사용자 지정 표시 및 알림 바인딩 정보를 설정합니다.
호출 전 및 사용 단계¶
현재 워크스페이스에서 workspace.setManage 권한을 가진 OpenAPI Key를 사용합니다. 적용 범위는 현재 Key가 속한 워크스페이스이며, Body에 다른 workspaceUUID를 전달하는 것은 지원하지 않습니다.
제출된 name/companyInfo/emailHeader/emailBottom/domain만 현재 워크스페이스의 bindInfo에 병합됩니다. 생략한 키는 유지되고, 명시적 빈 문자열은 초기화합니다. {}를 제출해도 업데이트 시간은 갱신됩니다. name은 바인딩 제품 표시 이름이며 워크스페이스 이름이 아니고, brandKey를 수정하지도, 브랜드 구성을 전환하지도 않습니다.
domain은 원본 문자열 그대로 저장되며, 성공을 도메인 연결 검수로 간주할 수 없습니다. DNS, TLS 인증서 및 프록시 구성은 관리자가 별도로 완료해야 합니다. 성공 시 content=true이며 새 객체를 반환하지 않습니다. 현재 워크스페이스의 content.bindInfo에서 다시 읽을 수 있습니다(상세 정보는 약 60초 캐시되므로 새로 고침 필요). 기존의 알 수 없는 레거시 bindInfo 키는 유지됩니다.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| companyInfo | string | 선택적 문자열이며, 생략 시 유지, 빈 문자열은 초기화합니다. 빈 문자열 허용: True 예시: 예시 회사의 서비스 설명획득 또는 입력 방법: 해당 워크스페이스에 표시할 회사/서비스 소개를 입력합니다. |
|
| domain | string | 선택적 문자열이며, 생략 시 유지, 빈 문자열은 초기화합니다. 현재 구현은 URL/도메인 형식을 검증하지 않으며, DNS, HTTPS 인증서, 게이트웨이 라우팅 구성 또는 도메인 소유권 확인도 수행하지 않습니다. 호출자가 직접 준비해야 합니다. 빈 문자열 허용: True 예시: portal.example.com획득 또는 입력 방법: 사이트/네트워크 관리자가 준비한 도메인을 제공받으며, 포트를 포함할 수 있고 프로토콜은 포함하지 않습니다. |
|
| emailBottom | string | 선택적 문자열이며, 이메일 하단에 표시할 텍스트입니다. 생략 시 유지, 빈 문자열은 초기화합니다. 빈 문자열 허용: True 예시: 请联系您的服务管理员획득 또는 입력 방법: 알림 내용을 담당하는 관리자가 제공합니다. |
|
| emailHeader | string | 선택적 문자열이며, 이메일 상단에 표시할 텍스트입니다. 생략 시 유지, 빈 문자열은 초기화합니다. 빈 문자열 허용: True 예시: 服务通知획득 또는 입력 방법: 알림 내용을 담당하는 관리자가 제공합니다. |
|
| name | string | 선택적 문자열이며, 생략 시 기존 값을 유지하고, 빈 문자열은 초기화합니다. 워크스페이스 name 또는 시스템 브랜드 식별자를 수정하는 용도로 사용하지 마십시오. 빈 문자열 허용: True 예시: Guance획득 또는 입력 방법: 현재 워크스페이스에 표시할 제품명을 입력합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/bind_info/set' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"Guance","companyInfo":"示例公司的服务说明","domain":"portal.example.com"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 저장됨 true이며, 도메인/DNS/인증서 사용 가능 여부나 클라이언트 캐시 새로 고침을 증명하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 파라미터 표의 JSON 객체를 제출합니다. |
| 401 | ft.WKSPNotExistOrReleased | 현재 워크스페이스가 존재하지 않거나 활성 상태가 아님 | 워크스페이스가 존재하지 않음/또는 해제됨 | 유효한 워크스페이스의 Key를 사용하고 상태를 확인합니다. |
| 500 | ft.InternalServerError | bindInfo 레거시 구조 이상, 데이터베이스 저장 실패 | 내부 오류 | 현재 워크스페이스 상세에서 저장 여부를 확인하고, 계속 실패하면 traceId를 제공합니다. |