Aperçu
- API Key and Secret : En pratique, le nom d’utilisateur et le mot de passe de votre App. Vous les utiliserez pour authentifier les requêtes qui nécessitent le Contexte utilisateur OAuth 1.0a, ou pour générer d’autres jetons tels que des Access Tokens utilisateur ou l’App Access Token.
- Access Token and Secret : En général, les Access Tokens représentent l’utilisateur pour le compte duquel vous effectuez la requête. Ceux que vous pouvez générer via le portail développeurs représentent l’utilisateur propriétaire de l’App. Vous les utiliserez pour authentifier les requêtes qui nécessitent le Contexte utilisateur OAuth 1.0a. Si vous souhaitez effectuer des requêtes au nom d’un autre utilisateur, vous devrez utiliser le flux OAuth à 3 étapes afin qu’il vous autorise.
- Client ID and Client Secret : Ces identifiants sont utilisés pour obtenir un Access Token utilisateur avec l’authentification OAuth 2.0. À l’instar d’OAuth 1.0a, les Access Tokens utilisateur servent à authentifier des requêtes qui fournissent des informations privées de compte utilisateur ou qui effectuent des actions au nom d’un autre compte, mais avec une portée fine pour un meilleur contrôle sur les accès de l’application cliente au compte utilisateur.
- App only Access Token : Vous utiliserez ce jeton lors de requêtes vers des endpoints qui renvoient des informations publiquement disponibles sur X.
Apps et Projects
Tableau de bord du portail développeurs
- Afficher vos Apps autonomes existantes et leur App ID associé.
- Créer un nouveau Project, une App ou une App autonome.
- Supprimer un Project ou une App inutilisé(e).
- Examiner ou mettre à jour les paramètres d’une App spécifique, y compris le nom, la description, le site web, l’URL de callback et les permissions.
- Régénérer des identifiants spécifiques à l’App, comme la Clé d’API et le Secret, l’App Access Token et les Access Tokens utilisateur du propriétaire de l’App.
Inscription pour accéder
Étiquetage de compte automatisé pour les bots
- Accédez aux paramètres de votre compte
- Sélectionnez « Votre compte »
- Sélectionnez « Automatisation »
- Sélectionnez « Gestion du compte »
- Sélectionnez ensuite le compte X qui exécute votre compte bot
- Saisissez votre mot de passe pour vous connecter
- Enfin, vous devriez voir une confirmation indiquant que le libellé a été appliqué à votre compte.
Gestion des Apps
Introduction
- Afficher vos Apps et Projects existants ainsi que leur App ID associé.
- Créer un nouveau Project ou une App autonome.
- Supprimer un Project, une App ou une App autonome.
- Ouvrir les paramètres d’une App spécifique en cliquant sur les paramètres de l’App. Dans ces paramètres, vous pouvez consulter les détails de l’App, ses clés et jetons, ainsi que ses autorisations.
- Mettre à jour les paramètres d’authentification utilisateur de votre App pour utiliser OAuth 1.0a ou OAuth 2.0.
Remarque :Toutes les clés et tous les jetons d’App ne sont plus visibles dans le portail développeurs et doivent être enregistrés en lieu sûr dès leur génération. Nous recommandons d’utiliser un gestionnaire de mots de passe pour stocker vos clés et jetons.Vous pouvez afficher un indice de Clé d’API pour vous aider à faire correspondre votre identifiant d’API à l’App correspondante.
Paramètres de l’App
Détails de l’App
Clés et jetons
- API Key (Consumer Key) et API Secret (Consumer Secret)
- App Access Token
- User Access Token et Access Token Secret - L’Access Token et le Secret disponibles dans le portail développeurs concernent l’utilisateur propriétaire de l’App.
Paramètres d’authentification utilisateur
Autorisations application-utilisateur OAuth 1.0a
Type d’App OAuth 2.0
Autorisations de l’App
Autorisations d’App OAuth 1.0a
- Lecture seule
- Lecture et écriture
- Lecture, écriture et accès aux Messages privés
Lecture seule
Lecture et écriture
Lecture, écriture et accès aux Messages privés
- POST /2/dm_conversations/:dm_conversation_id/messages
- POST /2/dm_conversations/
- POST /2/dm_conversations/with/:participant_id/messages
- GET /2/dm_conversations/with/:user_id/dm_events
- GET /2/dm_conversations/:dm_conversation_id/dm_events
- GET /2/dm_events
Détermination des autorisations
x-access-level
dans la réponse HTTP. La valeur de cet en-tête indique le niveau d’autorisation actuellement en vigueur. Les valeurs possibles sont read, read-write et read-write-directmessages.
URL de rappel
- Flux d’autorisation OAuth 2.0 par code avec PKCE
- Flux OAuth à 3 étapes OAuth 1.0a (et, séparément, le flux Se connecter avec X)
callback_url
lorsqu’ils effectuent une requête vers l’endpoint GET oauth/request_token. De même, les développeurs utilisant OAuth 2.0 Autorisation par code avec PKCE doivent transmettre le paramètre redirect_uri
avec leur requête vers l’endpoint GET oauth2/authorize.
En plus d’utiliser ces paramètres, le développeur doit également s’assurer que l’URL de rappel a été ajoutée à la liste d’autorisation des URL de rappel de son App, accessible depuis la page des paramètres de l’App sur le portail développeurs.
Si tout est correctement configuré, les développeurs seront redirigés vers l’URL de rappel après s’être connectés avec succès à X dans le cadre de ces flux.
Points à garder à l’esprit
callback_url
ou redirect_uri
, veillez à encoder l’URL en HTTP.
Limites des URL de callback
Il existe une limite stricte de 10 URL de callback dans le tableau de bord des X Apps. Votre URL de callback doit toujours correspondre exactement entre l’URL autorisée que vous ajoutez dans le tableau de bord des Apps et le paramètre que vous fournissez dans le flux d’autorisation.
Si vous souhaitez inclure des données propres à la requête dans l’URL de callback, vous pouvez utiliser le paramètre state
pour stocker des données qui seront incluses après la redirection de l’utilisateur. Vous pouvez soit encoder les données directement dans le paramètre state
, soit l’utiliser comme identifiant de session pour stocker l’état côté serveur.
N’utilisez pas localhost comme URL de callback
Au lieu d’utiliser localhost, utilisez un hôte personnalisé en local ou http(s)://127.0.0.1
URL à protocole personnalisé
Si vous souhaitez tirer parti du deep linking mobile, vous pouvez utiliser des URL à protocole personnalisé avec une partie chemin et une partie domaine, comme twitter://callback/path. Cependant, nous avons une liste de protocoles non autorisés à éviter. Vous pouvez consulter la liste des protocoles non autorisés ci‑dessous.
Protocoles non autorisés
vbscript | ldap |
javascript | mailto |
vbs | mmst |
data | mmsu |
mocha | msbd |
keyword | rtsp |
livescript | mso-offdap |
ftp | snews |
file | news |
gopher | nntp |
acrobat | outlook |
callto | stssync |
daap | rlogin |
itpc | telnet |
itms | tn3270 |
firefoxurl | shell |
hcp | sip |
Exemple d’erreur
HTTP 403 - Forbidden
HTTP 400