ChakraHQChakraHQ

Criar chave de API

Como criar uma chave de API?

Para usar as APIs do Chakra, primeiro você precisa criar uma chave de API para o seu caso de uso na seção Chaves de API .

Criar uma chave de API

Para criar uma chave de API, você precisa informar os seguintes dados:

  • Nome - Nome da chave. Use um nome significativo. Isso facilita o gerenciamento das chaves.
  • Descrição (opcional) - Descrição da chave de API
  • Função de acesso - Escolha uma role para a nova chave de API. A chave de API herdará os privilégios concedidos à função atribuída e ficará limitada a eles. Verifique se as chaves de API expostas publicamente têm a função com os privilégios mínimos necessários para realizar a tarefa.

Usar a chave de API

Na visualização de detalhes de uma chave de API, localize a seção Access Tokens . Copie o token de acesso para usar nas chamadas de API.

O token de acesso precisa ser enviado como um token Bearer no cabeçalho Authorization ao fazer chamadas de API.

Veja abaixo um exemplo de solicitação curl

curl --location --request POST 'https://api.chakrahq.com/v1/ext/plugin/whatsapp/d83e1d23-50b8-4d87-8f92-842a0ac516f6/phoneNumber/913399113344/send-template-message' \--header 'Authorization: Bearer Nv6TD2sYSdTi2PFAwhUACt1wL8g0k1DMswbckKGwwaPrWSpnhE92u9x7GRkyckQMOgYC6a9yJE9ZFiWD9OiqQYoMS4zx12CcbIa9b69Vrwtfou7nUlc2BTPIRDkGOR3Ak6YvLV3MGjzytO6i8X82w30jQxdG18HXrw1gjlVLCg0r92yDhr6s4Hkxtl1iIibA6GHcXtjaqSnTjq7I7JOQRicMFdWGBBX59vsB8jU4pQwIqq1XxuPtXMNN7jtMnPA' \--header 'Content-Type: application/json' \--data-raw '{	"whatsappPhoneNumberId": "775966265503012",	"templateName": "christmas_promo_23",	"mapping": [		{			"schemaPropertyName": "1",			"schemaPropertyValue": "John"		}	],  "imageUrl": "https://chakra-public-media.chakrahq.com/5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee/2024-10-17/9b755981-74f7-4cde-b495-cd7039991964.png"}'

Diretrizes para chaves de API

  • Use sempre chaves de API diferentes para cada caso de uso
  • Conceda apenas os privilégios necessários para seus casos de uso, usando a função atribuída durante a criação
  • Tenha cuidado ao usar chaves de API no código do frontend. Essas chaves devem ter o mínimo de privilégios possível

Nesta página