Proxy-seller

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

ps_docs_search

🢢 read

Pesquise na documentação da API e apresente trechos curtos.

ps_docs_get

🢢 read

Leia uma página da documentação ou uma única seção dela.

ps_api_list_endpoints

🢢 read

Liste as operações da API com método, caminho e resumo.

ps_api_get_endpoint

🢢 read

Detalhes completos de uma operação: parâmetros, corpo da solicitação, resposta, erros, exemplos e linguagens de SDK disponíveis.

ps_sdk_snippet

🢢 read

Um exemplo de código pronto para uso para uma operação.

ps_novidades

🢢 read

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

query obrigatório

string

Texto livre, um operation_id, ou um caminho de API

kind

guide | reference | sdk | errors

Limite a um tipo de documento

tags

string[]

Apenas documentos que tenham todas essas tags

limit

inteiro

Máximo de resultados, padrão 5

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

id obrigatório

string

ID do documento, por exemplo: guides/getting-started

section

string

A ## título da seção para retornar apenas essa seção

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

tag

string

Por exemplo: order, balance

query

string

Subsequência do ID da operação, título e caminho

method

GET | POST | PUT | PATCH | DELETE

Método HTTP

include_deprecated

booleano

Padrão false

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

operation_id obrigatório

string

Por exemplo: createOrder

ps_sdk_snippet

🢢 read-only · docs:read

Um exemplo de código pronto para uso para uma operação.

Parâmetro

Tipo

Descrição

operation_id obrigatório

string

Por exemplo: createOrder

lang obrigatório

python | node | php | go | java

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

since_corpus_sha

string

Apenas versões mais recentes do que esta

since_date

string (ISO 8601)

Apenas versões posteriores a esta data

Próximos passos

On this page