Documentación
Actualizado:
Estas herramientas leen la documentación de la API de Proxy-Seller incluida en el paquete. Nunca acceden a tu cuenta y funcionan sin necesidad de una clave de API de cliente.
Permisos: docs:read
Qué se incluye. Estas herramientas responden a partir de una instantánea del API del cliente v2 Documentación, en inglés: una página de referencia para cada operación publicada, las guías y fragmentos de código del SDK para Python, Node.js, PHP, Go y Java. La instantánea se actualiza unos minutos después de que se modifique la propia documentación.
En este grupo
Herramienta | Para qué sirve | |
|---|---|---|
🟢 | Busca en la documentación de la API y extrae fragmentos breves. | |
🟢 | Lee una página de documentación o una sola sección de la misma. | |
🟢 | Enumera las operaciones de la API con el método, la ruta y un resumen. | |
🟢 | Detalles completos de una operación: parámetros, cuerpo de la solicitud, respuesta, errores, ejemplos y lenguajes disponibles del SDK. | |
🟢 | Un ejemplo de código listo para usar para una operación. | |
🟢 | Versiones recientes de la documentación y lo que se ha añadido, modificado o eliminado en cada una de ellas. |
ps_docs_search
🟢 read-only · docs:read
Busca en la documentación de la API y extrae fragmentos breves.
Parámetro | Tipo | Descripción |
|---|---|---|
| cadena | Texto libre, un |
|
| Limítate a un solo tipo de documento |
| string[] | Solo documentos que tengan todas estas etiquetas |
| entero | Máximo de resultados, por defecto |
ps_docs_get
🟢 read-only · docs:read
Lee una página de documentación o una sola sección de la misma.
Parámetro | Tipo | Descripción |
|---|---|---|
| cadena | ID del documento, p. ej. |
| cadena | A |
ps_api_list_endpoints
🟢 read-only · docs:read
Enumera las operaciones de la API con el método, la ruta y un resumen. Las operaciones obsoletas se ocultan de forma predeterminada.
Parámetro | Tipo | Descripción |
|---|---|---|
| cadena | Por ejemplo: |
| cadena | Subcadena sobre el ID de la operación, el título y la ruta |
|
| Método HTTP |
| booleano | Por defecto |
ps_api_get_endpoint
🟢 read-only · docs:read
Detalles completos de una operación: parámetros, cuerpo de la solicitud, respuesta, errores, ejemplos y lenguajes disponibles del SDK. Las operaciones obsoletas deben incluir el nombre de la operación que las sustituye.
Parámetro | Tipo | Descripción |
|---|---|---|
| cadena | Por ejemplo: |
ps_sdk_snippet
🟢 read-only · docs:read
Un ejemplo de código listo para usar para una operación.
Parámetro | Tipo | Descripción |
|---|---|---|
| cadena | Por ejemplo: |
|
| Idioma del SDK |
ps_novedades
🟢 read-only · docs:read
Versiones recientes de la documentación y lo que se ha añadido, modificado o eliminado en cada una. Las más recientes primero.
Parámetro | Tipo | Descripción |
|---|---|---|
| cadena | Solo versiones más recientes que esta. |
| cadena (ISO 8601) | Solo versiones posteriores a esta fecha |