Policy:User-Agent policy/ko

2010년 2월 15일부터 위키미디어 사이트는 모든 요청에 대해 HTTP 사용자-에이전트 헤더를 요구합니다. 이것은 기술 직원이 내린 운영 결정이며 기술 메일링 리스트에 발표되고 논의되었습니다. 이유는 사용자-에이전트 문자열을 보내지 않는 클라이언트는 대부분 프로젝트에 도움이 되지 않고 서버에 많은 부하를 유발하는 잘못된 동작을 하는 스크립트라는 것입니다. python-requests/x와 같이 설명이 없는 기본값으로 시작하는 사용자 에이전트 문자열은 위키미디어 사이트(또는 웹사이트의 일부, 예: api.php)에서 차단될 수도 있습니다.

설명적인 사용자-에이전트 헤더를 보내지 않는 요청(예: 브라우저 또는 스크립트에서)은 다음과 같은 오류 메시지가 나타날 수 있습니다.

"스크립트는 연락처 정보와 함께 유익한 사용자 에이전트 문자열을 사용해야 합니다. 그렇지 않으면 예고 없이 차단될 수 있습니다."

허용되지 않은 사용자 에이전트의 요청에는 다음과 같이 덜 유용한 오류 메시지가 표시될 수 있습니다:

"현재 서버에 기술적인 문제가 발생했습니다. 몇 분 후에 다시 시도하십시오."

이 변경 사항은 api.php 또는 기타 명령줄 프로그램을 통해 위키백과와 같은 위키미디어 웹사이트에 자동으로 액세스하는 스크립트(봇)에 영향을 미칠 가능성이 높습니다. 봇을 실행하는 경우 다른 많은 봇과 혼동되지 않는 식별자로 봇을 식별하고 귀하에게 연락할 수 있는 방법(예: 로컬 위키의 사용자 페이지, 사용자 페이지)을 제공하는 사용자-에이전트 헤더를 보내주십시오. 위키 간 연결 구문, 관련 외부 웹사이트의 URI 또는 이메일 주소를 사용하는 관련 위키에서, 예:

User-Agent: CoolBot/0.0 (https://example.org/coolbot/; coolbot@example.org) generic-library/0.0

일반 형식은 <client name>/<version> (<contact information>) <library/framework name>/<version> [<library name>/<version> ...]입니다. 해당되지 않는 부분은 생략 가능합니다.

자동 에이전트를 실행하는 경우 사용자-에이전트 문자열에 "bot" 문자열을 소문자 또는 대문자 조합으로 포함하는 인터넷 전체 규칙을 따르는 것을 고려하십시오. 이것은 위키미디어의 시스템에서 인식되며 트래픽을 분류하고 보다 정확한 통계를 제공하는 데 사용됩니다.

Do not copy a browser's user agent for your bot, as bot-like behavior with a browser's user agent will be assumed malicious. Do not use generic agents such as "curl", "lwp", "Python-urllib", and so on. For large frameworks like pywikibot, there are so many users that just "pywikibot" is likely to be somewhat vague. Including detail about the specific task/script/etc would be a good idea, even if that detail is opaque to anyone besides the operator.

Web browsers generally send a User-Agent string automatically; if you encounter the above error, please refer to your browser's manual to find out how to set the User-Agent string. Note that some plugins or proxies for privacy enhancement may suppress this header. However, for anonymous surfing, it is recommended to send a generic User-Agent string, instead of suppressing it or sending an empty string. Note that other features are much more likely to identify you to a website — if you are interested in protecting your privacy, visit the Cover Your Tracks project.

Browser-based applications written in JavaScript are typically forced to send the same User-Agent header as the browser that hosts them. This is not a violation of policy, however such applications are encouraged to include the Api-User-Agent header to supply an appropriate agent.

As of 2015, Wikimedia sites do not reject all page views and API requests from clients that do not set a User-Agent header. As such, the requirement is not automatically enforced. Rather, it may be enforced in specific cases as needed.

Code examples

On Wikimedia wikis, if you don't supply a User-Agent header, or you supply an empty or generic one, your request will fail with an HTTP 403 error. Other MediaWiki installations may have similar policies.

JavaScript

If you are calling the API from browser-based JavaScript, you won't be able to influence the User-Agent header: the browser will use its own. To work around this, use the Api-User-Agent header:

// Using XMLHttpRequest
xhr.setRequestHeader( 'Api-User-Agent', 'Example/1.0' );

// Using jQuery
$.ajax( {
    url: 'https://example/...',
    data: ...,
    dataType: 'json',
    type: 'GET',
    headers: { 'Api-User-Agent': 'Example/1.0' },
} ).then( function ( data )  {
    // ..
} );

// Using mw.Api
var api = new mw.Api( {
    ajax: {
        headers: { 'Api-User-Agent': 'Example/1.0' }
    }
} );
api.get( ... ).then( function ( data ) {
    // ...
});

// Using Fetch
fetch( 'https://example/...', {
    method: 'GET',
    headers: new Headers( {
        'Api-User-Agent': 'Example/1.0'
    } )
} ).then( function ( response ) {
    return response.json();
} ).then( function ( data ) {
    // ...
});

PHP

In PHP, you can identify your user-agent with code such as this:

ini_set( 'user_agent', 'CoolBot/0.0 (https://example.org/coolbot/; coolbot@example.org)' );

cURL

Or if you use cURL:

curl_setopt( $curl, CURLOPT_USERAGENT, 'CoolBot/0.0 (https://example.org/coolbot/; coolbot@example.org)' );

Python

In Python, you can use the Requests library to set a header:

import requests

url = 'https://example/...'
headers = {'User-Agent': 'CoolBot/0.0 (https://example.org/coolbot/; coolbot@example.org)'}

response = requests.get(url, headers=headers)

Or, if you want to use SPARQLWrapper like in https://people.wikimedia.org/~bearloga/notes/wdqs-python.html:

from SPARQLWrapper import SPARQLWrapper, JSON

url = 'https://example/...'
user_agent = 'CoolBot/0.0 (https://example.org/coolbot/; coolbot@example.org)'

sparql = SPARQLWrapper(url, agent = user_agent )
results = sparql.query()

같이 보기

• Policy for crawlers and bots that wish to operate on Wikimedia websites