클라이언트

X API의 메인 클라이언트 클래스

X API와 상호작용하기 위한 기본 진입점입니다. 전문화된 클라이언트 모듈을 통해 모든 API 엔드포인트에 접근할 수 있으며, 인증, 요청 설정, 오류 처리를 담당합니다.

Example

import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: '베어러 토큰'
});

// 사용자 정보 가져오기
const user = await client.users.getUser('783214');

// 페이지네이션으로 팔로워 가져오기
const followers = await client.users.getFollowers('783214', {
  maxResults: 10,
  userFields: ['id', 'name', 'username']
});

// 팔로워를 순회하기
for await (const follower of followers) {
  console.log(follower.username);
}

​

생성자

​

constructor

• new Client(config): Client

새로운 X API 클라이언트 인스턴스를 생성합니다

​

매개변수

이름	타입	설명
config	any	클라이언트용 구성 옵션

​

반환값

Client

예시

// 베어러 토큰 인증
const client = new Client({
  bearerToken: 'your-bearer-token'
});

// OAuth 2 인증
const client = new Client({
  accessToken: 'your-access-token'
});

// OAuth 1 인증
const client = new Client({
  oauth1: oauth1Instance
});

client.ts:306

​

속성

baseUrl · string · required

API 요청의 기본 URL

bearerToken · string

인증용 Bearer 토큰

accessToken · string

OAuth2 액세스 토큰

oauth1 · any

인증용 OAuth1 인스턴스

headers · Headers · required

요청 헤더

timeout · number · required

요청 타임아웃(밀리초)

retry · boolean · required

실패한 요청을 자동 재시도할지 여부

maxRetries · number · required

최대 재시도 횟수

userAgent · string · required

User-Agent 문자열

httpClient · HttpClient = httpClient · required

요청 수행용 HTTP 클라이언트

users · UsersClient · required

Users 클라이언트

communityNotes · CommunityNotesClient · required

Community Notes 클라이언트

lists · ListsClient · required

Lists 클라이언트

connections · ConnectionsClient · required

Connections 클라이언트

posts · PostsClient · required

Posts 클라이언트

spaces · SpacesClient · required

Spaces 클라이언트

media · MediaClient · required

Media 클라이언트

directMessages · DirectMessagesClient · required

Direct Messages 클라이언트

communities · CommunitiesClient · required

Communities 클라이언트

accountActivity · AccountActivityClient · required

Account Activity 클라이언트

webhooks · WebhooksClient · required

Webhooks 클라이언트

trends · TrendsClient · required

Trends 클라이언트

activity · ActivityClient · required

Activity 클라이언트

stream · StreamClient · required

Stream 클라이언트

usage · UsageClient · required

Usage 클라이언트

compliance · ComplianceClient · required

Compliance 클라이언트

general · GeneralClient · required

General 클라이언트

request · Promise<T> · required

X API에 인증된 요청 보내기

이 메서드는 모든 API 요청에 대해 인증, 요청 포맷팅, 오류 처리를 담당합니다. 클라이언트 구성에 따라 적절한 인증 헤더를 자동으로 추가합니다.

isTokenExpired · boolean · required

OAuth2 토큰 만료 여부 확인

refreshToken · Promise<void> · required

OAuth2 토큰 갱신

isAuthenticated · boolean · required

현재 인증 상태 확인

mapSecuritySchemeToAuthTypes · string[] · required

OpenAPI 보안 스킴 이름을 내부 인증 유형으로 매핑

validateAuthentication · void · required

필요한 인증 방식이 사용 가능한지 확인

getAvailableAuthTypes · string[] · required

사용 가능한 인증 유형 조회