Documentation
Updated:
Ces outils lisent la documentation de l'API Proxy-Seller fournie. Ils n'accèdent jamais à votre compte et fonctionnent sans clé API client.
Autorisations : docs:read
Ce qui est couvert. Ces outils s'appuient sur un instantané de la API client v2 Documentation, en anglais : une page de référence pour chaque opération publiée, les guides et des extraits de code SDK pour Python, Node.js, PHP, Go et Java. L'instantané est mis à jour quelques minutes après la modification de la documentation elle-même.
Dans ce groupe
Outil | Fonctionnalités | |
|---|---|---|
🟢 | Effectuez des recherches dans la documentation de l'API et fournissez de courts extraits. | |
🟢 | Lisez une page de documentation ou une section de celle-ci. | |
🟢 | Répertorier les opérations de l'API en indiquant la méthode, le chemin d'accès et un résumé. | |
🟢 | Détails complets concernant une opération : paramètres, corps de la requête, réponse, erreurs, exemples, langages SDK disponibles. | |
🟢 | Un exemple de code prêt à l'emploi pour une opération. | |
🟢 | Versions récentes de la documentation et liste des ajouts, modifications ou suppressions apportés à chacune d'entre elles. |
ps_docs_search
🟢 read-only · docs:read
Effectuez des recherches dans la documentation de l'API et fournissez de courts extraits.
Paramètre | Type | Description |
|---|---|---|
| chaîne | Texte libre, un |
|
| Limitez-vous à un seul type de document |
| string[] | Uniquement les documents comportant toutes ces balises |
| entier | Nombre maximal de résultats, par défaut |
ps_docs_get
🟢 read-only · docs:read
Lisez une page de documentation ou une section de celle-ci.
Paramètre | Type | Description |
|---|---|---|
| chaîne | Identifiant du document, par exemple : |
| chaîne | A |
ps_api_list_endpoints
🟢 read-only · docs:read
Répertoriez les opérations de l'API en indiquant la méthode, le chemin d'accès et un résumé. Les opérations obsolètes sont masquées par défaut.
Paramètre | Type | Description |
|---|---|---|
| chaîne | Par exemple : |
| chaîne | Extrait de chaîne concernant l'identifiant de l'opération, le titre et le chemin d'accès |
|
| Méthode HTTP |
| booléen | Par défaut |
ps_api_get_endpoint
🟢 read-only · docs:read
Détails complets d'une opération : paramètres, corps de la requête, réponse, erreurs, exemples, langages SDK disponibles. Pour les opérations obsolètes, indiquez le nom de l'opération qui les remplace.
Paramètre | Type | Description |
|---|---|---|
| chaîne | Par exemple : |
ps_sdk_snippet
🟢 read-only · docs:read
Un exemple de code prêt à l'emploi pour une opération.
Paramètre | Type | Description |
|---|---|---|
| chaîne | Par exemple : |
|
| Langage du SDK |
ps_whats_new
🟢 read-only · docs:read
Versions récentes de la documentation et liste des ajouts, modifications ou suppressions apportés à chacune d'entre elles. Les plus récentes en premier.
Paramètre | Type | Description |
|---|---|---|
| chaîne | Uniquement les versions plus récentes que celle-ci |
| chaîne de caractères (ISO 8601) | Uniquement les versions postérieures à cette date |