प्रमाणीकरण

TypeScript SDK अलग-अलग उपयोग परिदृश्यों के लिए कई प्रमाणीकरण विधियों का समर्थन करता है।

बेयरर टोकन (ऐप-ओनली प्रमाणीकरण)

रीड-ओनली ऑपरेशन और सार्वजनिक डेटा एक्सेस के लिए:

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 (उपयोगकर्ता संदर्भ)

लीगेसी ऐप्स या विशिष्ट उपयोग मामलों के लिए:

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 (उपयोगकर्ता संदर्भ)

उपयोगकर्ता-विशिष्ट ऑपरेशन के लिए:

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);

  // उपयोगकर्ता authUrl पर जाकर ऐप को अधिकृत करता है
  // अधिकृत करने के बाद, उपयोगकर्ता code पैरामीटर के साथ वापस रीडायरेक्ट हो जाता है
  // callback URL से code निकालें (उदाहरण के लिए, query params से)
  const authCode: string = 'code-from-callback-url'; // इसे OAuth callback से मिले वास्तविक code से बदलें

  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);

  // उपयोगकर्ता authUrl पर जाकर ऐप को अधिकृत करता है
  // अधिकृत करने के बाद, उपयोगकर्ता code पैरामीटर के साथ वापस रीडायरेक्ट हो जाता है
  // callback URL से code निकालें (उदाहरण के लिए, query params से)
  const authCode = 'code-from-callback-url'; // इसे OAuth callback से मिले वास्तविक code से बदलें

  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);
});

पर्यावरण चर

संवेदनशील क्रेडेंशियल को पर्यावरण चरों में संग्रहीत करें:

# .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 });

JavaScript/TypeScript XDK का उपयोग करने वाले विस्तृत कोड उदाहरणों के लिए, हमारा code samples GitHub repo देखें।

​बेयरर टोकन (ऐप-ओनली प्रमाणीकरण)

​OAuth 1.0a (उपयोगकर्ता संदर्भ)

​OAuth 2.0 (उपयोगकर्ता संदर्भ)

​पर्यावरण चर

बेयरर टोकन (ऐप-ओनली प्रमाणीकरण)

OAuth 1.0a (उपयोगकर्ता संदर्भ)

OAuth 2.0 (उपयोगकर्ता संदर्भ)

पर्यावरण चर