API 액세스

#개요

Yeap Cloud 콘솔은 HTTPS JSON API를 기반으로 실행됩니다. 이 페이지에서는 API 주소, 인증 방식, 프로그래밍 방식으로 액세스할 때의 현재 제한 사항을 설명합니다.

#API 엔드포인트

https://api.yeap.cloud

• 인증 엔드포인트는 /auth/... 아래에 있습니다. 예를 들어 /auth/login과 /auth/refresh-token이 있습니다.
• 로그인한 사용자가 필요한 엔드포인트는 /api/user/... 아래에 있습니다. 예를 들어 /api/user/profile이 있습니다.

요청과 응답은 JSON 형식입니다. 요청 본문을 전송할 때는 Content-Type: application/json을 포함합니다.

#인증

#액세스 토큰

콘솔에 로그인하면 서버가 액세스 토큰(JWT)을 발급합니다. /api/user/... 아래의 엔드포인트를 호출하려면 요청 헤더에 이 토큰을 포함합니다.

Authorization: Bearer <access-token>

• 액세스 토큰의 유효 기간은 약 24 hours입니다.
• 토큰이 없거나 유효하지 않거나 만료된 경우 API는 HTTP 401을 반환합니다.

{"error": "Unauthorized", "code": 401}

• 계정이 비활성화되면 이미 발급된 토큰도 즉시 사용할 수 없게 됩니다.
• 콘솔에서 로그아웃하면 현재 액세스 토큰이 무효화되고 계정의 갱신 토큰도 폐기됩니다.

#갱신 토큰

로그인할 때 로그인 상태 유지를 선택하면 서버가 14 days 동안 유효한 갱신 토큰도 발급합니다. 액세스 토큰이 만료되면 다시 로그인하는 대신 갱신 토큰을 새 액세스 토큰으로 교환합니다.

curl -X POST https://api.yeap.cloud/auth/refresh-token \
  -H "Content-Type: application/json" \
  -d '{"refresh_token": "<refresh-token>"}'

성공 응답은 다음과 같습니다.

{"success": true, "token": "<new-access-token>", "user": { ... }}

갱신 토큰이 유효하지 않거나 만료된 경우 응답은 {"success": false, "error": "Invalid or expired refresh token"}이며 다시 로그인해야 합니다. 콘솔은 이 갱신 과정을 자동으로 처리합니다.

#로그인 시 사람 확인 필요

/auth/login을 호출할 때마다 사람 확인 절차를 통과해야 합니다(콘솔에서는 팝업으로 표시됩니다). 2단계 인증을 사용하는 계정은 일회용 코드도 입력해야 합니다. 따라서 현재는 사용자 개입 없이 스크립트로 로그인할 수 없습니다.

#예제: 프로필 조회

curl https://api.yeap.cloud/api/user/profile \
  -H "Authorization: Bearer <access-token>"

성공 응답은 다음과 같습니다.

{"success": true, "data": {"id": 123, "username": "...", "email": "...", ...}}

대부분의 사용자 엔드포인트는 {"success": true, "data": ...} 형식으로 응답합니다. 오류가 발생하면 {"success": false, "error": "description"}을 반환합니다.

#설정의 "API 키"

개인 설정 → API 키 탭에서 API 키를 생성, 조회, 삭제할 수 있습니다.

1. 설명을 입력하고 키 생성을 클릭합니다.
2. 키는 한 번만 표시됩니다. 즉시 복사하여 안전한 곳에 보관합니다.
3. 기존 키 목록에는 각 키의 ID, 생성 시간, 마지막 사용 시간이 표시됩니다. 더 이상 필요하지 않은 키는 삭제를 클릭하여 삭제합니다.

#CDN의 "DNS API" 페이지는 Yeap Cloud 자격 증명과 무관합니다

/cdn/dns-api의 CDN → DNS API에는 타사 DNS 제공업체(현재 Cloudflare)의 API 자격 증명을 저장합니다. Zone.Zone.Read 및 Zone.DNS.Edit 권한이 있는 API Token을 사용하는 것이 좋습니다. 이 자격 증명은 DNS-01 검증을 통해 CDN 도메인의 SSL 인증서를 자동으로 발급받는 데 사용됩니다. Yeap Cloud API 액세스와는 관련이 없습니다. CDN 문서를 참조하십시오.

#제품별 키

일부 제품에는 이 페이지에서 설명한 콘솔 토큰과 별개인 자체 키가 있습니다. 예를 들어 LLM API → 토큰 관리가 있습니다. 각 제품의 문서를 참조하십시오.

#보안 권장 사항

• 액세스 토큰과 갱신 토큰이 있으면 로그인한 것과 같은 권한을 갖습니다. 다른 사람과 공유하거나 소스 관리 시스템에 커밋하지 마십시오.
• 토큰이 유출된 것으로 의심되면 콘솔에서 로그아웃하고 비밀번호를 변경하십시오.
• 계정에 2단계 인증을 활성화하십시오.