빠른 시작

​

blocks 조회 엔드포인트 시작하기

이 빠른 시작 가이드는 Postman을 사용하여 blocks 조회 엔드포인트에 첫 요청을 보내는 방법을 안내합니다.

다양한 언어의 샘플 코드를 보려면 X API v2 샘플 코드 GitHub 리포지토리를 방문하세요.

​

사전 준비 사항

이 가이드를 완료하려면 요청을 인증할 키와 토큰 세트가 필요합니다. 다음 단계를 따라 키와 토큰을 발급받을 수 있습니다:

• 개발자 계정에 가입하여 승인을 받습니다.
• 개발자 포털에서 Project와 연결된 Developer 앱을 생성합니다.
• App의 “Keys and tokens” 페이지로 이동해 필요한 자격 증명을 생성합니다. 모든 자격 증명은 안전한 위치에 보관하세요.

​

차단 조회 요청을 구성하는 단계

​

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

이 엔드포인트에 요청을 보내는 데 사용할 수 있는 다양한 도구, 코드 예제, 라이브러리가 있지만 여기서는 과정을 단순화하기 위해 Postman을 사용하겠습니다.

X API v2 Postman 컬렉션을 환경에 로드하려면 아래 버튼을 클릭하세요:

X API v2를 Postman에 추가

Postman에서 X API v2 컬렉션을 로드한 후 “Blocks” 폴더로 이동해 “Blocks Lookup”을 선택하세요.  

​

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를 지정해야 합니다.

Postman에서 “Params” 탭으로 이동한 뒤, 섹션 하단의 id 경로 변수 “Value” 열에 해당 사용자 ID를 입력하세요. 사용자 이름 앞뒤에 공백이 없도록 주의하세요.  

Key	Value
id	(사용자 ID)
max_results	5

​

4단계: 가져오려는 필드를 식별하고 지정하기

3단계 이후 “Send” 버튼을 클릭하면 응답에서 기본 user object 필드인 id, name, username이 반환됩니다.

id, name, username 외의 추가 필드를 받으려면 요청에 fields 및/또는 expansions 매개변수를 사용해 해당 필드를 지정해야 합니다.

이 실습에서는 서로 다른 오브젝트에서 다음의 세 가지 추가 필드 세트를 요청합니다:

1. 기본 사용자 오브젝트의 추가 user.created_at 필드
2. 반환된 사용자에 대해 연관된 고정된 게시물 객체의 기본 필드: id, text
3. 연관된 게시물 오브젝트의 추가 tweet.created_at 필드

Postman에서 “Params” 탭으로 이동하여 “Query Params” 표에 다음 key:value 쌍을 추가하세요:

Key	Value	Returned fields
user.fields	created_at	user.created_at
expansions	pinned_tweet_id	tweet.id, tweet.text
tweet.fields	created_at	includes.tweets.created_at

이제 “Send” 버튼 옆의 URL에 TwitterDev의 URL 대신 본인의 사용자 ID가 포함된 유사한 URL이 표시되어야 합니다:

      https://api.x.com/2/users/2244994945/blocking?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

​

5단계: 요청 보내고 응답 확인하기

모든 설정을 마쳤다면 “Send” 버튼을 클릭하세요. 아래 예시와 유사한 응답을 받게 됩니다:

    {
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Twitter Support"
    },
    {
      "created_at": "2007-02-20T14:35:54.000Z",
      "id": "783214",
      "username": "Twitter",
      "name": "Twitter"
    },
    {
      "pinned_tweet_id": "1389270063807598594",
      "created_at": "2018-11-21T14:24:58.000Z",
      "id": "1065249714214457345",
      "username": "TwitterSpaces",
      "name": "Spaces"
    },
    {
      "pinned_tweet_id": "1293595870563381249",
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "username": "XAPI",
      "name": "X API"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-05-03T17:26:09.000Z",
        "id": "1389270063807598594",
        "text": "이제 팔로워가 600명 이상인 모든 사용자가 Space를 호스팅할 수 있습니다.\n\n지금까지의 경험에 따르면, 이러한 계정은 기존 오디언스를 보유하고 있어 호스팅 시 양호한 경험을 제공할 가능성이 높습니다. 모든 사용자에게 Space 생성 기능을 제공하기 전에 몇 가지 사항에 집중하고 있습니다. 🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "X API v2: 얼리 액세스 출시\n\n오늘 새로운 X API의 첫 번째 엔드포인트에 대한 얼리 액세스를 발표했습니다!\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }

​

6단계: 결과 페이지네이션

응답의 하단에는 meta 객체가 포함되어 있습니다. next_token을 받은 경우, 추가로 가져올 수 있는 다음 페이지의 결과가 있음을 의미합니다. 다음 페이지의 결과를 가져오려면 next_token 필드의 값을 가져와 요청에 추가 pagination_token 매개변수의 값으로 포함하세요.  

키	값
pagination_token	1D3PU6DRII9HEZZZ

이 추가 매개변수를 포함해 요청을 보내면, 3단계에서 max_results를 5로 지정했기 때문에 다음 5개의 결과가 이후 페이로드로 반환됩니다. 모든 결과가 반환될 때까지 이 과정을 반복할 수 있지만, max_results 매개변수를 사용하면 요청당 최대 1000명의 사용자를 요청할 수 있으므로 페이지네이션 횟수를 줄일 수 있습니다.