메인 콘텐츠로 건너뛰기

검색 Spaces 엔드포인트 시작하기

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

Spaces 검색 요청 빌드 단계

1단계: 도구 또는 라이브러리로 시작하기 이 엔드포인트로 요청을 보내는 데 사용할 수 있는 다양한 도구, 코드 예제, 라이브러리가 있지만 여기서는 과정을 단순화하기 위해 Postman을 사용합니다. X API v2 Postman 컬렉션을 환경에 불러오려면 다음 버튼을 클릭하세요: Postman에 X API v2 컬렉션을 불러온 후 Spaces 폴더로 이동하여 “Search Spaces” 요청을 찾습니다.   2단계: 요청 인증하기 X API에 올바르게 요청하려면 권한이 있는지 확인해야 합니다. 이를 위해 이 엔드포인트는 OAuth 2.0 App-Only 또는 OAuth 2.0 Authorization Code with PKCE 방식 중 하나로 요청을 인증해야 합니다. 단순화를 위해 이 요청에서는 OAuth 2.0 App-Only를 사용하겠지만, 비공개 metrics나 비공개 사용자의 Spaces를 요청하려면 다른 인증 방식을 사용해야 합니다.  OAuth 2.0 App-Only를 사용하려면 Postman에 키와 토큰, 특히 App Access Token (App-only Bearer Token이라고도 함)을 추가해야 합니다. 이를 위해 Postman 우측 상단의 “X API v2” 환경을 선택한 뒤, 환경 드롭다운 옆의 눈 아이콘을 클릭해 “initial value” 및 “current value” 필드에 키와 토큰을 입력하세요. 올바르게 설정했다면 이 변수들은 요청의 Authorization 탭에 자동으로 반영됩니다.   3단계: 검색 쿼리 만들기 이 엔드포인트는 텍스트를 검색 쿼리로 받습니다. 다른 검색 엔드포인트와 달리 연산자, 그룹화, 논리 연산자는 지원하지 않습니다. 이 연습에서는 간단한 쿼리로 “hello”를 사용합니다. Postman에서 “Params” 탭으로 이동하여 id 매개변수의 “Value” 열에 이 사용자 ID를 입력하세요.
KeyValue
queryhello
4단계: 가져올 필드 식별 및 지정하기 3단계 후 “Send” 버튼을 클릭하면 기본적으로 응답에 반환되는 유일한 Space 객체 필드인 Spaces의 ID와 상태를 받게 됩니다. 추가 필드를 받으려면 요청에 space.fields 또는 expansions 매개변수를 사용해 지정해야 합니다. 이 연습에서는 서로 다른 객체에서 세 가지 추가 필드 세트를 요청합니다:
  • 기본 Spaces 객체의 추가 title 필드
  • 지정된 creator ID의 전체 사용자 객체
  • 연관된 사용자 객체의 추가 user.created_at 필드
Postman에서 “Params” 탭으로 이동하여 “Query Params” 표에 다음 키:값 쌍을 추가하세요:
KeyValueReturned fields
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
이제 “Send” 버튼 옆에 다음 URL이 표시되어야 합니다: https://api.x.com/2/spaces/search?query=hello&space.fields=creator_id&expansions=creator_id&user.fields=created_at 5단계: 요청 보내고 응답 확인하기 모든 설정이 완료되면 “Send” 버튼을 눌러 다음 응답을 받습니다:
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Hello world 👋",
        "state": "Running"
   },
   "<GLOSSARY>includes</GLOSSARY>": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}