Bootstrap Bootstrap

Rank API 문서

Rank API 문서에 오신 것을 환영합니다. 이 API는 개발자가 다양한 프로그램의 순위 데이터를 제출하고 조회할 수 있도록 합니다.

기본 URL

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

엔드포인트

1. 순위 제출

엔드포인트: /submit_rank
메서드: POST
설명: 새로운 프로그램 순위를 제출합니다.

요청 본문:

{
        "program_key": "string",  // 프로그램의 고유 식별자
        "score": "integer",       // 사용자의 점수
        "username": "string"      // 사용자의 이름
    }
    

응답:

{
        "message": "Rank submitted successfully"
    }
    

요청 예시:

curl -X POST https://www.한뼘코딩.com/api/submit_rank \
        -H "Content-Type: application/json" \
        -d '{
                "program_key": "abc123",
                "score": 95,
                "username": "user1"
            }'
    

2. 상위 10명의 순위 조회

엔드포인트: /get_ranks/<program_key>
메서드: GET
설명: 특정 프로그램의 상위 10명의 순위를 조회합니다.

URL 파라미터:

program_key (string): 프로그램의 고유 식별자.

응답:

[
        {
            "username": "string",          // 사용자의 이름
            "score": "integer",            // 사용자의 점수
            "timestamp": "ISO 8601 string" // 순위 제출 시간
        },
        ...
    ]
    

요청 예시:

curl https://www.한뼘코딩.com/api/get_ranks/abc123
    

사용 예시

1. 순위 제출:

curl -X POST https://www.한뼘코딩.com/api/submit_rank \
        -H "Content-Type: application/json" \
        -d '{
                "program_key": "abc123",
                "score": 95,
                "username": "user1"
            }'
    

2. 상위 10명의 순위 조회:

curl https://www.한뼘코딩.com/api/get_ranks/abc123
    

주의사항

  • 제공된 program_key가 각 프로그램마다 고유하도록 하여 충돌을 피하십시오.
  • 점수는 내림차순으로 정렬되며, 동일한 점수인 경우 제출된 시간으로 정렬됩니다.
  • 현재 성능 문제로 상위 10명의 순위만 조회할 수 있습니다.

결론

이 API는 다양한 프로그램의 순위 데이터를 제출하고 조회할 수 있는 간단한 인터페이스를 제공합니다. 질문이나 문제가 있을 경우 API 관리자에게 문의하십시오.