메인 콘텐츠로 건너뛰기

음소거 관리 엔드포인트 시작하기

이 빠른 시작 가이드는 Postman을 사용해 음소거 관리 엔드포인트에 첫 요청을 보내는 방법을 안내합니다. 다양한 언어의 샘플 코드를 보고 싶다면 X API v2 샘플 코드 GitHub 리포지토리를 방문하세요.
사전 준비 사항이 가이드를 완료하려면 요청 인증에 사용할 키와 토큰 세트가 필요합니다. 다음 단계를 따라 키와 토큰을 생성하세요:
  • 개발자 계정에 등록하고 승인을 받습니다.
  • 개발자 포털에서 Project와 연결된 Developer 앱을 생성합니다.
  • App의 “Keys and tokens” 페이지로 이동해 필요한 자격 증명을 생성합니다. 모든 자격 증명은 안전한 위치에 보관하세요.

음소거 관리 요청을 빌드하는 단계

1단계: 도구 또는 라이브러리부터 시작하기

이 엔드포인트에 요청을 보내는 데 사용할 수 있는 다양한 도구, 코드 예제, 라이브러리가 있지만, 여기서는 과정을 단순화하기 위해 Postman을 사용하겠습니다. X API v2 Postman 컬렉션을 환경에 로드하려면 다음 버튼을 클릭하세요: Postman에 X API v2 컬렉션을 로드한 후 “Mutes” 폴더로 이동하여 “Mute a user’s ID”를 선택하세요.  

2단계: 요청 인증

X API에 올바르게 요청하려면 권한을 확인해야 합니다. 이 엔드포인트에서는 OAuth 1.0a 사용자 컨텍스트 또는 OAuth 2.0 Authorization Code with PKCE 중 하나로 요청을 인증해야 합니다. 이 예제에서는 OAuth 1.0a 사용자 컨텍스트를 사용합니다. Postman에 키와 토큰—구체적으로 API Key, API Secret Key, OAuth 1.0a 사용자 액세스 토큰, OAuth 1.0a 사용자 액세스 토큰 시크릿—을 추가해야 합니다. 이를 위해 Postman 우측 상단에서 “X API v2” 환경을 선택한 뒤, “initial value” 및 “current value” 필드에 키와 토큰을 추가합니다(환경 드롭다운 옆의 눈 아이콘을 클릭). 올바르게 설정했다면 이러한 변수들이 요청의 authorization 탭에 자동으로 반영됩니다.  

3단계: 누가 누구를 뮤트할지 지정하기

뮤트 관리 엔드포인트에는 두 개의 ID가 필요합니다. 하나는 사용자(다른 사용자를 뮤트하거나 뮤트 해제하려는 사용자)용이고, 다른 하나는 대상 사용자(뮤트되거나 뮤트 해제될 사용자)용입니다. 사용자 ID는 인증하는 사용자 ID와 일치해야 하므로, 요청을 인증할 때 해당 사용자 ID와 연결된 액세스 토큰을 전달해야 합니다. 이 경우 본인의 사용자 ID를 지정할 수 있습니다. 자신의 ID는 다음 두 가지 방법으로 찾을 수 있습니다.
  1. user lookup by username 엔드포인트를 사용해 사용자 이름을 전달하면 id 필드를 받을 수 있습니다.
  2. 액세스 토큰의 숫자 부분이 본인의 사용자 ID입니다.  
대상 ID는 유효한 사용자 ID라면 어떤 것이든 사용할 수 있습니다. Postman에서 “Params” 탭으로 이동해 id 경로 변수의 “Value” 열에 자신의 ID를 입력하세요. “Body” 탭으로 이동해 뮤트하려는 사용자의 ID를 target_user_id 매개변수의 값으로 입력하세요. 어떤 ID 앞뒤에도 공백이 없도록 하세요.
KeyValue
id인증된 사용자 ID
target_user_id뮤트하려는 사용자 ID

4단계: 요청을 보내고 응답을 검토하기

모든 설정을 마쳤다면 “Send” 버튼을 클릭하세요. 그러면 아래 예시와 유사한 응답이 반환됩니다:
      { "data": { "muting": true } }
“muting”: true를 받으면 해당 id가 target_user_id을(를) 성공적으로 음소거한 것입니다 같은 사용자의 음소거를 해제하려면 Postman에 로드된 X API v2 컬렉션의 “Mutes” 폴더에 있는 “Unmute a user ID” 요청을 사용하세요. source_user_id는 본인의 사용자 ID여야 하고, target_user_id는 음소거를 해제할 대상의 사용자 ID여야 합니다. 이를 JSON 본문으로 추가할 필요는 없으므로, source_user_id 및 target_user_id에 필요한 쿼리 매개변수를 추가했는지 확인하세요. 음소거가 성공적으로 해제되면 다음 예시와 유사한 응답을 받게 됩니다:
      { "data": { "muting": false } }