# Autenticação na API

#### **Autenticação na API**

<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">Todas as requisições http feitas aos servidores da Oystr devem conter, no header da requisição, o parâmetro </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">***<span data-slate-string="true">X-Oystr-Auth</span>***</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">, com o seu </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">***<span data-slate-string="true">token</span>***</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true"> de autenticação.</span></span></span>

<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">Todas as requisições para nossa API demandam o uso do </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">**<span data-slate-string="true">header</span>**</span></span> <span data-slate-node="text"><span data-slate-leaf="true">***<span data-slate-string="true">X-Oystr-Auth</span>***</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">, 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á </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">**<span data-slate-string="true">HTTP/1.1 403 Forbidden</span>**</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">, indicando a ausência de permissões para efetuar a requisição.</span></span></span>

<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">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.</span></span></span>

#### **<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">Como obter a chave de API</span></span></span>**

<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">Antes de mais nada, a primeira coisa que você precisa fazer é obter a sua </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">**<span data-slate-string="true">chave de API (API Key)</span>**</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">. Sem ela, você não conseguirá se autenticar na API e, consequentemente, não conseguirá consumir seus métodos.</span></span></span>

<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">Abaixo, segue um passo a passo de como obter a sua chave de API:</span></span></span>

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

<span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">Sua chave será criada e exibida no console. Para consumir a API, basta copiar a chave criada e passar no </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">***<span data-slate-string="true">HEADER</span>***</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">, conforme indicado no método de </span></span></span><span data-slate-node="text"><span data-slate-leaf="true">***<span data-slate-string="true">Autenticação na API</span>***</span></span><span data-slate-node="text"><span data-slate-leaf="true"><span data-slate-string="true">.</span></span></span>

<div class="ResponsiveContainer__StyledResponsiveContainerColumn-sc-1y2ta6q-0 ibCncS eight-wide-column mobile-twelve-wide-column sc-qYhdC hSfsBF entity-description-container" data-click="" data-testid="aether-responsive-container" id="bkmrk-" overflow="unset"><div class="sc-kMYVKZ hgLdXH mimir" data-testid="test-mimir-main" id="bkmrk--1"></div></div>