Skip to main content
POST
https://suasofia.online/api/
/
user
/
api-keys
Criar chave API
curl --request POST \
  --url https://suasofia.online/api/user/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "message": "Chave API criada com sucesso.",
  "api_key": {
    "name": "Chave API de Produção",
    "token": "1|abc123xyz789abcdef...",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}
Este endpoint gera uma nova chave API para o usuário autenticado. Diferentemente do endpoint de login que cria um token de sessão, este cria uma chave API persistente que pode ser usada para acesso de longo prazo à API.
Este endpoint requer autenticação. Use sua chave API existente ou token de sessão para criar chaves API adicionais.

Corpo da Requisição

name
string
required
Um nome/rótulo para a chave API (ex: “Produção”, “Desenvolvimento”, “Meu App”)

Resposta

message
string
Mensagem de sucesso
api_key
object
Detalhes da chave API criada
{
  "message": "Chave API criada com sucesso.",
  "api_key": {
    "name": "Chave API de Produção",
    "token": "1|abc123xyz789abcdef...",
    "created_at": "2025-01-08T10:30:00.000000Z"
  }
}

Exemplo de Requisição

curl -X POST https://suasofia.online/api/user/api-keys \
  -H "Authorization: Bearer SUA_CHAVE_API_EXISTENTE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Chave API de Produção"
  }'
O token da chave API é retornado apenas uma vez. Certifique-se de armazená-lo com segurança. Se você perdê-lo, precisará criar uma nova chave.

Gerenciando Chaves API

  • GET /user/api-keys - Listar todas as chaves API para o usuário autenticado
  • DELETE /user/api-keys/ - Deletar uma chave API específica