Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

API Key

André devkcud Albanese edited this page Aug 7, 2024 · 4 revisions

🔐 API Key

Para utilizar a API precisamos de uma chave de API, que o público poderá adquirir no futuro.

Com a chave em maos, podemos fazer nossas requisições. Um exemplo de requisição seria o abaixo:

import axios from "axios";

// Certifique-se de que a chave de API tenha as permissões necessárias
await axios.get("https://api.swibly.com.br/v1/user/johndoe/profile", {
  headers: { "X-API-KEY": "minha-chave" },
});

Com as chaves de API, alguns novos erros aparecerão, como os de chave inválida e de que a API chegou em seu limite. Lembre-se de trata-los.


Warning

Por conta deste módulo ser especifico para uso interno, a documentação será reduzida.

Permissões: API key + EnabledKeyManagement

  • GET /key/all
  • GET /key/mine (Required Authorization Bearer)
  • POST /key/create (Optional Authorization Bearer for stablishing ownership)
  • GET /key/:id
  • DELETE /key/:id
  • PATCH /key/:id

Clone this wiki locally