Skip to content

Autenticação

Para utilizar os serviços da plataforma SipPulse AI, todas as requisições devem ser autenticadas usando uma chave API. Este guia explica como configurar e utilizar as chaves API para autenticação.

Obtendo sua Chave API

Para gerar uma chave API, siga as instruções na seção API Keys da documentação.

Usando a Chave API

Todas as requisições para a plataforma SipPulse AI devem incluir a chave API no cabeçalho da requisição. O cabeçalho utilizado é api-key. Abaixo estão exemplos de como incluir a chave API em requisições utilizando diferentes linguagens de programação.

bash
curl -X 'GET' \
  'https://api.sippulse.ai/v1/llms/models' \
  -H 'Content-Type: application/json' \
  -H 'api-key: $SIPPULSE_API_KEY'
python
import requests

url = "https://api.sippulse.ai/v1/llms/models"
headers = {
    "Content-Type": "application/json",
    "api-key": "SIPPULSE_API_KEY"
}

response = requests.get(url, headers=headers)
print(response.json())
javascript
const url = "https://api.sippulse.ai/v1/llms/models";
const headers = {
  "Content-Type": "application/json",
  "api-key": "SIPPULSE_API_KEY",
};

fetch(url, {
  method: "GET",
  headers: headers,
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error:", error));

Segurança da Chave API

  • Confidencialidade: Nunca compartilhe suas chaves API publicamente. Evite incluí-las em código de navegador ou cliente.
  • Rotação de Chaves: Periodicamente, gere novas chaves API e substitua as antigas para melhorar a segurança.
  • Revogação: Caso uma chave API seja comprometida, revogue-a imediatamente através da seção API Keys.