메인 콘텐츠로 건너뛰기
이 가이드는 첫 요청을 보내기 위해 따라야 할 몇 가지 단계를 안내합니다. X 계정에 가입한 뒤 활용하기 좋은 자료입니다. 코드 샘플, 더 기술적인 가이드, 또는 Postman 같은 그래픽 도구를 사용하고자 한다면, 첫 요청을 보내는 데 아래 가이드를 참고하세요: 이 가이드는 여러분이 API key 및 secret, 사용자 액세스 토큰 및 시크릿, 앱 액세스 토큰을 발급받아 안전한 위치에 보관했다고 가정합니다. 방법은 X API 액세스 받기 가이드의 단계를 따라 확인할 수 있습니다.

1단계. 사용할 엔드포인트 선택

X API를 사용하면 X 웹사이트나 모바일 앱에서 할 수 있는 다양한 작업을 코드로 수행할 수 있습니다. API에서 제공되는 엔드포인트의 전체 목록은 API Reference Index에 정리되어 있지만, 단순하게 시작하려면 다음 중 하나를 권장합니다.

2단계. 요청을 구성할 도구를 선택하세요

일부 요청은 간단하지만, 다른 요청은 구현이 까다로울 수 있습니다. 그래서 뛰어난 개발자 커뮤니티가 복잡한 부분을 추상화하는 도구를 만들어 제공하고 있습니다. 아래는 권장 도구와 사용 방법에 대한 안내입니다:

Postman

Postman은 REST 엔드포인트에 요청을 보낼 수 있는 시각적 도구입니다. X API를 통해 제공되는 다양한 엔드포인트를 빠르게 시작하고 탐색할 수 있도록 Postman 관련 자료를 준비했습니다. 키와 토큰을 추가하고 첫 요청을 보내는 방법을 알아보려면 “Postman 시작하기” 튜토리얼을 읽어보시길 권장합니다. 또한 대부분 Postman을 사용하는 X API v2 엔드포인트별 빠른 시작 가이드를 제공합니다. 각 엔드포인트 섹션에서 해당 가이드를 확인할 수 있으며, 몇 가지는 다음과 같습니다:
  • 빠른 시작: 게시물 작성
  • 빠른 시작: 게시물 검색
  • 빠른 시작: 사용자 조회
Postman으로는 스트리밍 엔드포인트에 요청을 보낼 수 없습니다. 해당 엔드포인트를 사용하는 방법은 필터링된 스트림 또는 1% 샘플 스트림 빠른 시작 가이드를 참고하세요. 더 단순한 그래픽 도구를 선호한다면 Insomnia 사용도 고려해 보세요.

샘플 코드

요청을 보낼 때 간단한 코드를 사용하고 싶다면, 각 X API v2 엔드포인트마다 여러 언어로 준비된 샘플 코드를 제공하고 있습니다. 코드 샘플은 GitHub 리포지토리 X-API-v2-sample-code에서 확인할 수 있으며, 요청을 올바르게 실행할 수 있도록 자격 증명 설정 방법을 안내하는 README 파일도 포함되어 있습니다. 예를 들어, 아래는 사용자 조회 엔드포인트용 cURL 예시입니다. 이 요청을 사용하려면 ACCESS_TOKEN과 USERNAME을 각각 앱 액세스 토큰과 X 핸들로 바꾸면 됩니다. 그런 다음 이 코드를 명령줄 도구에 복사해 붙여넣고 ‘Return’ 또는 ‘Enter’를 누르세요.
curl "https://api.x.com/2/users/by/username/$USERNAME" -H "Authorization: Bearer $ACCESS_TOKEN"

라이브러리

활발한 X Developer 커뮤니티는 다양한 프로그래밍 언어로 X API에 요청을 보낼 수 있는 라이브러리도 구축했습니다. 저희는 커뮤니티 라이브러리를 모두 정리해 둔 “도구 및 라이브러리” 페이지를 제공하고 있습니다. 각 라이브러리에는 로컬 환경에서 리포지토리를 설정하고 첫 요청을 보내는 방법을 안내하는 README 파일이 포함되어 있어야 합니다.
참고: 문제가 발생하면, 요청하려는 엔드포인트에 대한 개발자 문서와 지원 섹션을 확인하시거나, 포럼의 커뮤니티에 도움을 요청해 주세요. 성공적인 요청을 하실 수 있도록 도와드리겠습니다!

3단계. 응답 검토

요청이 성공하면 해당 요청과 관련된 메타데이터가 포함된 페이로드를 받습니다. GET HTTP 메서드를 사용하는 엔드포인트를 사용했다면, 요청한 리소스(게시물, 사용자, List, Space 등)와 관련된 메타데이터를 JSON 형식으로 받게 됩니다. 반환된 각 필드를 검토하고, 요청한 정보가 X의 콘텐츠와 어떻게 매핑되는지 확인하세요. POST, PUT, DELETE HTTP 메서드를 사용하는 엔드포인트를 사용했다면, X에서 동작을 수행한 것입니다. X.com 또는 모바일 앱에서 해당 동작이 반영되었는지 확인하세요.

4단계. 매개변수로 요청 조정하기

각 엔드포인트에는 요청을 조정하는 데 사용할 수 있는 서로 다른 매개변수 집합이 있습니다. 예를 들어 GET 엔드포인트에서는 fields 및 expansions 매개변수를 사용해 추가 메타데이터 필드를 요청할 수 있습니다. 또한 search Posts, Post counts, filtered stream 등의 엔드포인트에서 다양한 필터링 도구를 활용해 수신하는 데이터를 관심 있는 게시물로 한정할 수 있습니다. 사용 중인 엔드포인트의 API Reference에서 요청 매개변수와 필드의 전체 목록을 확인할 수 있으며, 통합 가이드와 기본 사항 페이지에서 기타 유용한 통합 정보를 폭넓게 확인할 수 있습니다. Important resources 가이드를 통해 제공 중인 모든 교육 자료에 대해 더 알아볼 수 있습니다.