Exemplos de Discussions
Uma requisição e uma resposta para cada operação de Discussions: listar, obter, criar, atualizar e excluir uma avaliação ou comentário.
Esta página mostra uma chamada para cada operação da API de Discussions, com a requisição, os códigos de status e a resposta. As chamadas usam $BASE_URL/api/2.0 e as credenciais HTTP Basic $EMAIL:$API_KEY. Leia na ordem: a chamada de criação devolve o id que as chamadas de atualização e exclusão usam depois.
Listar avaliações e comentários
/api/2.0/discussionsAdminObter a lista de avaliações e comentários com suas propriedades
Exemplo de requisição
curl -u "$EMAIL:$API_KEY" -X GET "$BASE_URL/api/2.0/discussions/"Obter uma avaliação ou comentário
/api/2.0/discussions/{id}AdminObter os detalhes de uma avaliação ou comentário pelo id
Parâmetros de caminho
idintegerobrigatórioExemplo de requisição
curl -u "$EMAIL:$API_KEY" -X GET "$BASE_URL/api/2.0/discussions/18"Criar uma avaliação ou comentário
/api/2.0/discussionsAdminCriar uma nova avaliação ou comentário
Campos obrigatórios: object_type + object_id, ou thread_id.
Campos disponíveis: object_type, object_id, thread_id, name, message, rating_value, timestamp, status.
Exemplo de requisição
Este exemplo cria uma avaliação de produto de John Doe para o produto com product_id=242. A nota é 4 de 5 estrelas e a mensagem é "Hi, I use the API!".
curl -u "$EMAIL:$API_KEY" -H "Content-Type: application/json" -X POST "$BASE_URL/api/2.0/discussions" -d '{"object_type":"P", "object_id":242, "name":"John Doe", "rating_value":4, "message":"Hi, I use the API!"}'Resposta
{
"post_id": 22
}Erros
| Status | Quando |
|---|---|
201 Created | Avaliação ou comentário criado com sucesso |
400 Bad Request | Parâmetros da requisição inválidos |
Atualizar uma avaliação ou comentário
/api/2.0/discussions/{id}AdminAtualizar uma avaliação ou comentário existente
Parâmetros de caminho
idintegerobrigatórioCampos disponíveis: name, message, rating_value, timestamp, status.
Exemplo de requisição
Este exemplo atualiza a avaliação ou comentário com post_id=22. Ele muda rating_value para 5, altera a mensagem para "Changed message via API" e define o status como D (reprovado).
curl -u "$EMAIL:$API_KEY" -H "Content-Type: application/json" -X PUT "$BASE_URL/api/2.0/discussions/22" -d '{"rating_value":5, "message":"Changed message via API", "status":"D"}'Resposta
{
"post_id": 22
}Excluir uma avaliação ou comentário
/api/2.0/discussions/{id}AdminExcluir uma avaliação ou comentário específico
Parâmetros de caminho
idintegerobrigatórioExemplo de requisição
Este exemplo exclui a avaliação ou comentário com post_id=22.
curl -u "$EMAIL:$API_KEY" -X DELETE "$BASE_URL/api/2.0/discussions/22"Erros
| Status | Quando |
|---|---|
204 No Content | Avaliação ou comentário excluído com sucesso |
400 Bad Request | A avaliação ou comentário não pôde ser excluído |
404 Not Found | A avaliação ou comentário não existe |