Authentication using Web API Keys Show 이 페이지는 아직 한국어로 번역되지 않았습니다.현재 이 문서 페이지의 한국어 버전이 없으므로 아래에 영어 버전이 표시됩니다. Some Web API methods return publicly accessible data and do not require authorization when called. Other methods may require you to use a unique API key. There are also methods that return sensitive data or perform a protected action and require special access permissions. These APIs require a publisher key, which you will need to create before calling any of them. In cases where an API key is required, it can be provided either as a standard parameter or by setting the 'x-webapi-key' request header value. User KeysThe standard user keys are available to everyone, all that is required is a Steam account and the domain name that will be associated with this key. You will also need to agree to the Steam Web API Terms of Use. You can create a user Web API key from the registration page on the Steam Community. Publisher KeysTo securely identify a publisher, and allow access to protected methods, a publisher may request a Web API key which can be passed to the appropriate methods using the key parameter. Each key is associated with a publisher group and can be used to access data for all of the App IDs that are also associated with that group. To receive a publisher Web API key, see Creating a Publisher Key below. Publisher Web API keys provide access to sensitive user data and protected methods. These keys are intended to be used for Web API requests that originate from secure publisher servers. The keys must be stored securely, and must not be distributed with a game client. All Web API requests that contain Web API keys should be made over HTTPS. Creating a Publisher Web API KeyTo create a publisher Web API key, you will need to have administrator permissions within an existing Steamworks account. If you are not an administrator yourself, you can see a list of administrators for your partner account by visiting your Steamworks Home Page and viewing the list on the right-hand side. Any one of them can create your Publisher Web API Key or can promote you to admin if appropriate. To create a Publisher Web API key:
개요Steam은 다양한 Steamworks 기능에 액세스하는 데 사용되는 HTTP 기반의 웹 API를 제공합니다. API는 게임 클라이언트 또는 서버와 같이 HTTP 요청이 가능한 모든 애플리케이션에서 액세스할 수 있는 공용 메서드를 담고 있습니다. API는 또한 인증이 필요한 보호된 메서드를 포함하며, 신뢰할 수 있는 백엔드 애플리케이션에 액세스할 수 있도록 고안되었습니다. 예를 들면, 보안 게시자 서버는 보통 웹 API 메서드를 다음과 같은 목적으로 사용합니다.
Steamworks 웹 API에서 제공하는 모든 메서드의 목록은 Steamworks 웹 API 참고자료에서 확인하실 수 있습니다. 요청 형식개방형 Steamworks 웹 API는 Steamworks C++ API와 비슷하게, 웹 API도 관련 메서드를 포함한 여러 인터페이스로 나뉩니다. 각 API에 요청에 대한 URI 형식은 다음과 같습니다. https://api.steampowered.com/<interface>/<method>/v<version>/ 대부분 메서드는 필수 및 선택적 매개변수 목록을 지원합니다. 메서드에 따라 이러한 매개변수는 반드시 요청에서 GET 또는 POST 매개변수로 전달되어야 합니다. 모든 요청은 HTTP 1.1을 사용하여 전달해야 하며, 가능한 경우 보안 TLS 연결을 사용해야 합니다. 콘텐츠 유형은 인증많은 웹 API 메서드에는 고유한 키가 필요한 액세스 제한이 있습니다. 자세한 내용은 Authentication using Web API Keys 문서를 참고하세요. 배열 매개변수일부 매서드는 배열로 된 매개변수가 필요합니다. 이러한 매개변수는 매개변수 이름 끝에 ?count=2&name[0]=SomeNameHere&name[1]=SomeOtherName 서비스 인터페이스일반 웹 API 호출 외에도 서비스 인터페이스가 있습니다. 이러한 인터페이스는 일반 인터페이스와 매우 비슷한 기능을 합니다. 주요 차이점은
모든 서비스 API는 인수를 GET 또는 POST 매개변수로 취급할 뿐만 아니라 단일 JSON BLOB으로 받는다는 것입니다. JSON으로 데이터를 전달하기 위해서는 웹 API 메서드를 다음과 같이 ?key=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&input_json={"steamid":76561197972495328} JSON은 URL로 인코딩되어 있어야 한다는 점을 참고하세요. 'key'와 'format' 필드는 이전과 같이 계속해서 별도의 매개변수로 전달되어야 합니다. POST 요청도 지원됩니다. 웹 API가 '서비스'인지 여부는인터페이스의 이름으로 구분할 수 있습니다. 인터페이스의 이름이 IPlayerService와 같이 'Service'로 끝나는 경우 매개변수 데이터를 전달하는 이 추가 메서드를 지원합니다. 일부 Service 메서드는 조금 더 복잡한 구조의 매개변수를 사용하며 이러한 대체 입력 형식이 요구됩니다. 쿼리 예시다음 예시는 Team Fortress 2에 대한 최근 3개의 새로운 항목을 검색합니다. GET /ISteamNews/GetNewsForApp/v2/?appid=440&count=3\r\n Host: api.steampowered.com/r/n Content-Length: 0\r\n\r\n 다음 링크를 통해 이 쿼리를 시행하고 결과를 확인할 수
있습니다. 이 특정 호출에 대한 더 자세한 정보는 ISteamNews/GetNewsForApp 문서에서 확인하실 수 있습니다. 사용자의 SteamID 받기Steamworks 웹 API는 고유한 64비트 Steam ID를 이용하여 개별 사용자를 확인합니다. 사용자의 SteamID를 안전하게 받는 방법은 사용자 인증 및 소유권 문서에서 확인하세요. 개방형 웹 API( 보안 서버에서 보내는 모든 요청은 파트너 전용 노드(
IP 주소 허용 목록WebAPI 호출에 사용할 IP 주소를 허용 목록에 추가하실 수 있습니다. 이는 WebAPI 키가 도용된 경우를 위한 추가적인 보안 계층으로, 허용 목록에 추가된 IP 주소를 이용한 WebAPI 호출만 허용합니다. 허용 목록에 IP 주소를 추가하고 나면 허용 목록에 포함되지 않은 주소에 대한 다른 모든 요청은 차단되며 '403 - Forbidden' 오류 메시지가 표시됩니다. 허용 목록에 IP 주소를 추가하는 방법은 간단합니다. WebAPI 키를 보유하고 있는 그룹 페이지에서 'WebAPI 키 관리' 버튼을 클릭하고 지침을 따르세요. 각 WebAPI는 별도의 고유한 허용 목록이 있으며, 허용 목록에 IP 주소를 꼭 추가해야 하는 것은 아닙니다. 참고: 허용 목록을 사용하더라도 WebAPI 키에 대한 보안이 보장되는 것은 아닙니다. 키를 안전하게 보호하고 절대 공유하지 마세요. 만약 키가 도용된 경우, 즉시 변경하세요. |