Autenticação na API

Autenticação na API 

 Todas as requisições http feitas aos servidores da Oystr devem conter, no header da requisição, o parâmetro X-Oystr-Auth , com o seu token de autenticação. 

 Todas as requisições para nossa API demandam o uso do header X-Oystr-Auth , ele é obrigatório. Caso o token não seja informado no header da requisição ou caso o token seja inválido, o retorno do servidor, nas demais requisições, será HTTP/1.1 403 Forbidden , indicando a ausência de permissões para efetuar a requisição. 

 O método /ping é utilizado apenas para realização de autenticação na API. Para saber como obter a o seu token, acesse o link abaixo e siga as instruções ali definidas. 

 Como obter a chave de API 

 Antes de mais nada, a primeira coisa que você precisa fazer é obter a sua chave de API (API Key) . Sem ela, você não conseguirá se autenticar na API e, consequentemente, não conseguirá consumir seus métodos. 

 Abaixo, segue um passo a passo de como obter a sua chave de API: 

 

 Acesse o Console/Painel da Oystr (https://console4.oystr.com.br); 

 

 Sua chave será criada e exibida no console. Para consumir a API, basta copiar a chave criada e passar no HEADER , conforme indicado no método de Autenticação na API .