콘텐츠로 이동

【모바일 신서틱 테스트】사용 약관 확인



POST /api/v1/dialing_task/mobile/terms/accept

개요

약관 확인을 위해 유지되는 엔드포인트이며, OpenAPI Key로는 멤버 확인을 대체할 수 없습니다.

호출 전 및 사용 단계

이 공개 경로는 유지되지만, 컨트롤러는 실제 Front 로그인 세션의 워크스페이스 Owner/관리자만 확인하도록 허용하므로, DF-API-KEY로 정상 호출하면 403 ft.MobileDialTermsAcceptForbidden이 반환되며, Key로 성공적으로 확인할 수 있는 파라미터 조합은 존재하지 않습니다. 자격을 갖춘 멤버가 제품 내에서 내용을 읽고 확인한 뒤, 확인 상태 조회로 검증하시기 바랍니다.

요청 예시는 {}를 사용하며, acceptedBy/acceptedAt을 제공하여 기록을 위조할 수 없습니다. 이 OpenAPI 분기는 권한 검사 지점에서 종료되므로 확인 기록이나 성공 감사 로그를 생성하지 않습니다. 공유 Front 구현은 멱등 확인 및 서버 측 시간/신원 생성을 수행할 수 있으나, 이는 현재 Key 엔드포인트가 해당 동작을 지원함을 의미하지 않습니다.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다.

파라미터 추가 설명

로그인 세션의 워크스페이스 Owner 또는 관리자만 확인할 수 있으며, API Key는 허용되지 않습니다. 빈 요청 {}만 수신하고 버전, 사용자, 시간 또는 워크스페이스 필드는 수신하지 않습니다. 반복 성공 시 최초 사용자와 서버 Unix 초 단위 acceptedAt이 유지됩니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/mobile/terms/accept' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

응답

정상적인 OpenAPI 호출은 HTTP 403 JSON 오류를 반환하며, 아래는 실제 거부 구조를 보여주는 것으로 Key 호출로 성공적으로 확인할 수 있음을 의미하지 않습니다.

필드 타입 설명
content object OpenAPI가 정상적으로 거부할 때 content는 빈 오류 내용입니다. 이 route는 declaration을 건너뜁니다.
{
  "code": 403,
  "content": {},
  "errorCode": "ft.MobileDialTermsAcceptForbidden",
  "message": "로그인 세션의 워크스페이스 Owner 또는 관리자만 모바일 신서틱 테스트 사용 약관을 확인할 수 있습니다.",
  "success": false,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
400 ft.JsonFormatError Body 최상위가 JSON 객체가 아니며, 확인 권한 검사보다 먼저 실패 일부 json 파일 형식 오류 예시 {}대로 제출합니다. 유효한 객체라도 Key가 확인 권한을 얻을 수는 없습니다.
403 ft.MobileDialTermsAcceptForbidden OpenAPI 신원이 자격을 갖춘 Front 로그인 세션 멤버가 아님 로그인 세션의 워크스페이스 Owner 또는 관리자만 모바일 신서틱 테스트 사용 약관을 확인할 수 있습니다. 제품에 로그인하여 워크스페이스 Owner/관리자가 내용을 읽고 확인하며, API Key로 멤버를 가장하지 않습니다.

문서 평가

이 페이지가 도움이 되었나요?