OAuth

A autenticação OAuth permite que aplicações se conectem à Yourviews e acessem dados (como reviews, perguntas, etc) com a autorização de um usuário da Yourviews com direitos administrativos. É uma facilidade frente à Autenticação Basica que automatiza o processo de autenticação.

Chaves de Aplicação

Ao integrar com a Yourviews via oAuth, a aplicação precisa solicitar um ClientId e um SecretKey. A Yourviews irá gerar e informar à aplicação essas duas informações.
Para solicitar suas chaves, abra um chamado em nosso suporte.

Fluxo de autorização

Para permitir que a aplicação faça chamadas à API da Yourviews, é necessário obter um token. Para obter esse token é necessário seguir o processo de autorização. Para isso, seguir os passos:

1 - Sua aplicação redireciona o navegador do usuário para a URL de Autorização:
ex: https://service.yourviews.com.br/admin/apps/Authorize?clientId=XX&secretKey=XXX&redirect=https://www.minhaapp.com.br/callback?id=a

Note a na URL acima os seguintes parâmetros:

• clientId e secretKey: Chaves geradas pela Yourviews para sua aplicação;
• redirect: URL da sua aplicação. Essa URL receberá o Token gerado pela Yourviews. Sua aplicação deverá salvar esse token para posterior utilização.

2- A Yourviews exibirá a tela de permissão ao usuário, que deverá clicar no botão "Autorizar"

3 - Um token exclusivo é gerado e informado na URL de callback da aplicação, onde o cliente é redirecionado:
ex: https://www.minhaapp.com.br/callback?id=a&callback=TOKEN

Sua aplicação deverá persistir esse Token para utilizar nas chamadas à API posteriormente.

Fazendo chamadas à API

Após obter e salvar o Token de acesso, agora é possível fazer chamadas para a API da Yourviews.

Endpoint

O endpoint base para chamada segue o formato

https://service.yourviews.com.br/api/oauth/<endpoint>?token=XXXXXX

Note que em todas as chamadas deve ser passado o parâmetro token na URL. Esse parâmetro é obtido através do fluxo de autorização (vide tópico anterior)

Fazendo uma chamada

Você pode utilizar qualquer chamada para API disponível na documentação abaixo:
https://documenter.getpostman.com/view/3359543/yourviews-api/RVu8gSWM#4848b0fa-72f6-1baa-7e00-94b2d589eec7

Note, no entanto, que você precisa adaptar o endpoint da chamada, que deve seguir o formato acima.
Dessa forma, por exemplo, ao utilizar o método de busca de review por Id

Para buscar um review por ID de produto, pode ser feita a seguinte chamada (em formato cURL):

curl "https://service.yourviews.com.br/api/oauth/review?productId=ID_DO_PRODUT&token=XXXXXX"  -H "Content-Type: application/json"

O retorno da chamada é o mesmo que está descrito na documentação acima.