Documentação
Atualizado:
Essas ferramentas leem a documentação da API do Proxy-Seller incluída no pacote. Elas nunca acessam sua conta e funcionam sem uma chave da API do cliente.
Permissões: docs:read
O que está incluído. Essas ferramentas respondem com base em um instantâneo do API do cliente v2 documentação, em inglês: uma página de referência para cada operação publicada, os guias e trechos de código do SDK para Python, Node.js, PHP, Go e Java. O snapshot é atualizado alguns minutos após a própria documentação ser alterada.
Neste grupo
Ferramenta | O que ele faz | |
|---|---|---|
🢢 | Pesquise na documentação da API e apresente trechos curtos. | |
🢢 | Leia uma página da documentação ou uma única seção dela. | |
🢢 | Liste as operações da API com método, caminho e resumo. | |
🢢 | Detalhes completos de uma operação: parâmetros, corpo da solicitação, resposta, erros, exemplos e linguagens de SDK disponíveis. | |
🢢 | Um exemplo de código pronto para uso para uma operação. | |
🢢 | Versões recentes da documentação e o que cada uma adicionou, alterou ou removeu. |
ps_docs_search
🢢 read-only · docs:read
Pesquise na documentação da API e apresente trechos curtos.
Parâmetro | Tipo | Descrição |
|---|---|---|
| string | Texto livre, um |
|
| Limite a um tipo de documento |
| string[] | Apenas documentos que tenham todas essas tags |
| inteiro | Máximo de resultados, padrão |
ps_docs_get
🢢 read-only · docs:read
Leia uma página da documentação ou uma única seção dela.
Parâmetro | Tipo | Descrição |
|---|---|---|
| string | ID do documento, por exemplo: |
| string | A |
ps_api_list_endpoints
🢢 read-only · docs:read
Liste as operações da API com método, caminho e resumo. As operações obsoletas ficam ocultas por padrão.
Parâmetro | Tipo | Descrição |
|---|---|---|
| string | Por exemplo: |
| string | Subsequência do ID da operação, título e caminho |
|
| Método HTTP |
| booleano | Padrão |
ps_api_get_endpoint
🢢 read-only · docs:read
Detalhes completos de uma operação: parâmetros, corpo da solicitação, resposta, erros, exemplos e linguagens de SDK disponíveis. Operações obsoletas devem incluir o nome da operação substituta.
Parâmetro | Tipo | Descrição |
|---|---|---|
| string | Por exemplo: |
ps_sdk_snippet
🢢 read-only · docs:read
Um exemplo de código pronto para uso para uma operação.
Parâmetro | Tipo | Descrição |
|---|---|---|
| string | Por exemplo: |
|
| Idioma do SDK |
ps_novidades
🢢 read-only · docs:read
Versões recentes da documentação e o que cada uma adicionou, alterou ou removeu. As mais recentes aparecem primeiro.
Parâmetro | Tipo | Descrição |
|---|---|---|
| string | Apenas versões mais recentes do que esta |
| string (ISO 8601) | Apenas versões posteriores a esta data |