Parâmetros de Pedido

Editar online

O documento descreve os diversos parâmetros de solicitação que precisam ser definidos para um ponto de extremidade da API ou recurso de destino durante uma chamada de solicitação à API.

Dependendo do terminal da API ou do recurso de destino, poderá ser necessário definir os seguintes parâmetros na chamada de solicitação de API:

Dados de formulário

Use esses parâmetros para solicitar um token de acesso que o cliente da API precisa para chamadas de solicitação de API subsequentes:

Tabela 1. Parâmetros de dados de formulário
Parâmetros	Descrição
client_id	O ID do cliente que é designado ao cliente da API.
client_secret	O segredo do cliente que é designado ao cliente da API.
grant_type	É configurado para `client_credentials`.
scope	Uma lista delimitada por espaço de escopos que estão associados a esse token. O escopo válido para clientes da API é `openid`.

Cabeçalhos

Verify exige as seguintes informações no cabeçalho ` HTTP `:

Tabela 2. Parâmetros do cabeçalho
Parâmetros	Descrição
Content Type	Em um cabeçalho da solicitação, ele indica o tipo de dados que o cliente enviou para o servidor. Em um cabeçalho de resposta, ele indica o tipo de dados que são retornados para o cliente. Por exemplo, `-H "Content-type: application/json"`
Accept	Ele indica o tipo de conteúdo que o cliente pode entender e aceitar em uma resposta. Por exemplo, `-H "Accept: application/json" -H "Accept: image/png"`
Location	A URL do objeto recém-criado no cabeçalho do método de HTTP POST. Por exemplo, `/<resource-noun>/<resource-id>`.
Accept-Language	O idioma que o cliente entende ou prefere.

Parâmetros de consulta

Os parâmetros a seguir são opcionais, dependendo do que e como você deseja retornar os resultados de sua solicitação de API.

Tabela 3. Parâmetros de consulta
Parâmetros	Descrição
pagination	Se nenhum parâmetro de paginação for transmitido, todos os resultados serão retornados. O valor máximo permitido para o limite ou a contagem é 1000. `count` é o número total de resultados a serem retornados do armazenamento de dados. `page` é a página solicitada. `limit` é o número total de resultados a serem retornados em uma página.
sort	Cada atributo deve ser prefixado com + ou - (+ crescente, - decrescente). Múltiplos atributos devem ser separados por uma vírgula (,).
search	Operadores válidos para: As sequências são `= , !=` e `contains` Os booleanos são `=` e `!=` Os números são `>=`, `>`, `<=`, `<`, `=`, e `!=`
filter	Os formatos válidos são somente inclusivos ou somente exclusivos. Múltiplos parâmetros de filtro devem ser separados por uma vírgula (,).

Conteúdo

Use este parâmetro para solicitações POST, PUT e PATCH. Defina aqui os atributos e os valores que devem ser criados ou atualizados. Clique no tipo de dados Modelo ou Valor de exemplo para visualizar os atributos que devem ser definidos no corpo, incluindo o formato e o valor de amostra.

O tipo de conteúdo de parâmetro é application/json. O conteúdo é armazenado no formato de arquivo JSON.