Bearer Token (Autenticação apenas de app)
Para operações somente-leitura e acesso a dados públicos:quickstart.ts
import {
Client,
type ClientConfig,
type Users
} from '@xdevplatform/xdk';
const config: ClientConfig = { bearerToken: 'your-bearer-token' };
const client: Client = new Client(config);
async function main(): Promise<void> {
const userResponse: Users.GetByUsernameResponse = await client.users.getByUsername('XDevelopers');
const username: string = userResponse.data?.username!;
console.log(username);
}
main();
import { Client } from '@xdevplatform/xdk';
const client = new Client({ bearerToken: 'your-bearer-token' });
const userResponse = await client.users.getByUsername('XDevelopers');
const username = userResponse.data.username;
console.log(username);
OAuth 1.0a (Contexto de usuário)
Para aplicações legadas ou casos de uso específicos:oauth1.ts
import {
Client,
OAuth1,
type OAuth1Config,
type ClientConfig,
type Users
} from '@xdevplatform/xdk';
const oauth1Config: OAuth1Config = {
apiKey: 'your-api-key',
apiSecret: 'your-api-secret',
accessToken: 'user-access-token',
accessTokenSecret: 'user-access-token-secret'
};
const oauth1: OAuth1 = new OAuth1(oauth1Config);
const config: ClientConfig = {
oauth1: oauth1,
};
const client: Client = new Client(config);
async function main(): Promise<void> {
const response: Users.GetMeResponse = await client.users.getMe();
const me = response.data;
console.log(me);
}
main();
import { Client, OAuth1 } from '@xdevplatform/xdk';
const oauth1 = new OAuth1({
apiKey: 'your-api-key',
apiSecret: 'your-api-secret',
accessToken: 'user-access-token',
accessTokenSecret: 'user-access-token-secret'
});
const client = new Client({ oauth1: oauth1 });
const response = await client.users.getMe();
const me = response.data;
console.log(me);
OAuth 2.0 (Contexto de usuário)
Para operações específicas do usuário:oauth2.ts
import {
Client,
OAuth2,
generateCodeVerifier,
generateCodeChallenge,
type OAuth2Config,
type ClientConfig,
type OAuth2Token
} from '@xdevplatform/xdk';
(async (): Promise<void> => {
const oauth2Config: OAuth2Config = {
clientId: 'your-client-id',
clientSecret: 'your-client-secret',
redirectUri: 'https://example.com',
scope: ['tweet.read', 'users.read', 'offline.access'],
};
const oauth2: OAuth2 = new OAuth2(oauth2Config);
const state: string = 'example-state';
const codeVerifier: string = generateCodeVerifier();
const codeChallenge: string = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);
const authUrl: string = await oauth2.getAuthorizationUrl(state);
// User visits authUrl and authorizes the app
// After authorization, user is redirected back with a code parameter
// Extract the code from the callback URL (e.g., from query params)
const authCode: string = 'code-from-callback-url'; // Replace with actual code from OAuth callback
const tokens: OAuth2Token = await oauth2.exchangeCode(authCode, codeVerifier);
const config: ClientConfig = {
accessToken: tokens.access_token,
};
const client: Client = new Client(config);
});
import { Client, OAuth2, generateCodeVerifier, generateCodeChallenge } from '@xdevplatform/xdk';
(async () => {
const oauth2 = new OAuth2({
clientId: 'your-client-id',
clientSecret: 'your-client-secret',
redirectUri: 'https://example.com',
scope: ['tweet.read', 'users.read', 'offline.access'],
});
const state = 'example-state';
const codeVerifier = generateCodeVerifier();
const codeChallenge = await generateCodeChallenge(codeVerifier);
oauth2.setPkceParameters(codeVerifier, codeChallenge);
const authUrl = await oauth2.getAuthorizationUrl(state);
// User visits authUrl and authorizes the app
// After authorization, user is redirected back with a code parameter
// Extract the code from the callback URL (e.g., from query params)
const authCode = 'code-from-callback-url'; // Replace with actual code from OAuth callback
const tokens = await oauth2.exchangeCode(authCode, codeVerifier);
const client = new Client({ accessToken: tokens.access_token });
const response = await client.users.getMe();
const me = response.data;
console.log(me);
});
Variáveis de ambiente
Armazene credenciais sensíveis em variáveis de ambiente:# .env
X_API_BEARER_TOKEN=your-bearer-token
X_API_CLIENT_ID=your-client-id
X_API_CLIENT_SECRET=your-client-secret
env.ts
import { Client } from '@xdevplatform/xdk';
const client = new Client({ bearerToken: process.env.X_API_BEARER_TOKEN });
import { Client } from '@xdevplatform/xdk';
const client = new Client({ bearerToken: process.env.X_API_BEARER_TOKEN });
Para exemplos de código detalhados usando o XDK JavaScript/TypeScript, confira nosso repositório de exemplos de código no GitHub.