Program User API 문서

Program User API 문서에 오신 것을 환영합니다. 이 API는 사용자가 프로그램에 가입하고 로그인 및 로그아웃할 수 있도록 합니다.

기본 URL

https://www.한뼘코딩.com/api

엔드포인트

1. 회원 가입

엔드포인트: /register
메서드: POST
설명: 새로운 사용자를 프로그램에 등록합니다.

요청 본문:

{
        "program_key": "string",  // 프로그램의 고유 식별자
        "email": "string",        // 사용자의 이메일
        "password": "string"      // 사용자의 비밀번호
    }
    

응답:

{
        "message": "User registered successfully"
    }
    

요청 예시:

curl -X POST https://www.한뼘코딩.com/api/register \
        -H "Content-Type: application/json" \
        -d '{
                "program_key": "abc123",
                "email": "user@example.com",
                "password": "securepassword"
            }'
    

2. 로그인

엔드포인트: /login
메서드: POST
설명: 사용자가 프로그램에 로그인합니다.

요청 본문:

{
        "program_key": "string",  // 프로그램의 고유 식별자
        "email": "string",        // 사용자의 이메일
        "password": "string"      // 사용자의 비밀번호
    }
    

응답:

{
        "message": "Login successful"
    }
    

요청 예시:

curl -X POST https://www.한뼘코딩.com/api/login \
        -H "Content-Type: application/json" \
        -d '{
                "program_key": "abc123",
                "email": "user@example.com",
                "password": "securepassword"
            }'
    

3. 로그아웃

엔드포인트: /logout
메서드: POST
설명: 사용자가 프로그램에서 로그아웃합니다.

요청 본문:

{
        "program_key": "string",  // 프로그램의 고유 식별자
        "email": "string"         // 사용자의 이메일
    }
    

응답:

{
        "message": "Logout successful"
    }
    

요청 예시:

curl -X POST https://www.한뼘코딩.com/api/logout \
        -H "Content-Type: application/json" \
        -d '{
                "program_key": "abc123",
                "email": "user@example.com"
            }'
    

주의사항

• 제공된 program_key가 각 프로그램마다 고유하도록 하여 충돌을 피하십시오.
• 회원 가입 시 사용자의 이메일이 이미 존재하는 경우 400 상태 코드와 함께 에러 메시지가 반환됩니다.
• 로그인 시 이메일과 비밀번호가 일치하지 않으면 401 상태 코드와 함께 에러 메시지가 반환됩니다.

결론

이 API는 사용자가 프로그램에 가입하고, 로그인 및 로그아웃할 수 있는 간단한 인터페이스를 제공합니다. 질문이나 문제가 있을 경우 API 관리자에게 문의하십시오.