Leia mais sobre utilização de APIs assíncronas: https://yourviews.freshdesk.com/support/solutions/articles/5000784346-introducão
Integração de perguntas
A API de perguntas tem como objetivo integrar as perguntas assincronamente e prover indicativos e ações para uma pergunta que o cliente fez.
Lembre-se de ler sobre a introdução e autenticação da API: https://yourviews.freshdesk.com/support/solutions/articles/5000734890-api-basic-auth-primeiros-passos-e-autenticac%C3%A3o
IMPORTANTE: Você também pode verificar essa documentação com exemplos em nossa coleção do Postman:
Inserir uma pergunta
Endpoint: POST /asyncquestion/InsertQuestion
Para inserir uma pergunta, você deve informar todos os campos do mesmo. A tabela abaixo compila todos os campos (obrigatórios e opcionais) que podem ser enviados.
| Campo | Descrição | Obrigatório | Tipo |
|---|---|---|---|
| Question | Pergunta realizada | Sim | string |
| Date | Data da pergunta | Sim | DateTime (yyyy-MM-ddTHH:mm:ss) |
| User | Usuário que fez a pergunta | Sim | Nó |
| Name | Nome do usuário que fez a pergunta | Sim | Sim |
| E-mail do usuário que fez a pergunta | Sim | Sim | |
| UserId | Id do usuário que fez a pergunta | Não | Não |
| Product | Produto em que foi realizada a pergunta | Sim | Sim |
| ProductId | Id do produto | Sim | Sim |
| Name | Nome do produto | Sim | string |
| Url | URL do produto | Sim | string |
| Image | Foto do produto | Sim | string |
Exemplo de chamada
Para exemplificar a tabela acima, o JSON abaixo dá uma ideia de como os dados devem ser enviados.
{
"Answer": "Acabei de fazer uma resposta - 2",
"Date": "2018-01-12T17:40:14",
"User": {
"Name": "Alex Teste",
"Email": "alex+teste@yourviews.com.br"
},
"QuestionId": 612777
}API de respostas
A API de respostas da Yourviews tem como principal objetivo inserir as respostas para fazer a integração em nosso sistema para que retornar indicativos para uma tomada de decisão ou consulta de dados.
Lembre-se de ler sobre a introdução e autenticação da API: https://yourviews.freshdesk.com/support/solutions/articles/5000734890-api-basic-auth-primeiros-passos-e-autenticac%C3%A3o
IMPORTANTE: Você também pode verificar essa documentação com exemplos em nossa coleção do Postman:
Inserir uma resposta
Endpoint: POST /asyncanswer/
Para inserir uma resposta, você deve informar todos os campos do mesmo. A tabela abaixo compila todos os campos (obrigatórios e opcionais) que podem ser enviados.
| Resposta | Nó principal da resposta | ||
| Campo | Descrição | Obrigatório? | Tipo |
| Answer | Resposta | Sim | Alfanumérico |
| Date | Data da resposta | Sim | Data |
| UserAnswered | Se tem algum cliente na resposta | Não | Booleano |
| Likes | Quantidade de "likes" na resposta | Não | Inteiro |
| Dislikes | Quantidade de "dislikes" na resposta | Não | Inteiro |
| QuestionId | Id da questão da Yourviews | Não | Inteiro |
| AnswerId | Id da resposta da Yourviews. Observaçao: passar id quando for atualizar maior que 0 quando for atualizar a resposta. Caso contrário, irá inserir a resposta. | Não | Inteiro |
| User | Nó para colocar informações do cliente da resposta. | Não | |
| YourviewsUserId | Id do cliente da Yourviews. Se colocar valor maior que 0 o usuário será atualizado. Caso contrário, vai inserir o cliente. | Não | Inteiro |
| Name | Nome do cliente | Sim | Alfanumérico |
| Email | E-mail do cliente | Sim | Alfanumérico |
| City | Cidade do cliente. Não é um campo obrigatório, mas é recomendável colocar pelo motivo de alguns indicativos usam esse dado. | Não | Alfanumérico |
| State | Estado do cliente. Não é um campo obrigatório, mas é recomendável colocar pelo motivo de alguns indicativos usam esse dado. | Não | Alfanumérico |
| ZipCode | Cep do cliente. Não é um campo obrigatório, mas é recomendável colocar pelo motivo de alguns indicativos usam esse dado. | Não | Alfanumérico |
| UserId | Valor que desejar para identificar esse cliente. | Sim | Alfanumérico |
Exemplo de chamada
Para exemplificar a tabela acima, o JSON abaixo dá uma ideia de como os dados devem ser enviados.
HTML
{
"Answer": "Teste",
"Date": "2018-01-01 00:00:00",
"UserAnswered": false,
"User":
{
"Name": "Teste",
"Email": "exemplo@exemplo.com.br",
"City": "Sao Paulo",
"State": "SP",
"ZipCode": "9999999",
"UserId": "teste"
},
"Likes": 0,
"Dislikes": 0,
"QuestionId": 0,
"AnswerId": 0
}