Autenticação

A utilização da Meshy API requer autenticação. Este guia vai mostrar-lhe como criar uma conta e chaves de API.

API Keys

Criar uma conta Meshy

A Meshy API requer que tenha uma conta Meshy para criar e gerir chaves de API. Se for feito um pedido à API sem uma chave de API, a API responderá com um erro de credenciais inválidas.

Pode criar uma conta Meshy visitando o website oficial da Meshy e registando-se.

Criar chaves de API

Depois de criar uma conta Meshy, pode criar chaves de API na página API Keys na Developer Platform.

Pode criar várias chaves de API para diferentes finalidades. Por exemplo, pode criar uma chave de API para a sua aplicação iOS e outra para a sua aplicação web. A utilização de cada chave de API é monitorizada separadamente, e pode revogá-las a qualquer momento.

Também pode definir um limite mensal de créditos em qualquer chave, limitando o quanto ela pode gastar independentemente da utilização global da sua conta — útil para limitar uma chave que entregue a um contratado ou a um ambiente específico.

Para criar uma chave de API, clique no botão Create API Key na página da API e, em seguida, introduza um nome para a sua chave de API.

Depois de criar uma chave de API, será apresentado o valor da chave de API. Pode copiar o valor da chave de API e guardá-lo num local seguro.

Não poderá voltar a ver este valor da chave de API.

Utilizar chaves de API

Depois de criar uma chave de API, pode utilizá-la para autenticar os seus pedidos à Meshy API. Pode passar a sua chave de API à API no cabeçalho Authorization, um exemplo de cabeçalho é apresentado abaixo.

{
  "Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}

Segurança

Levamos a segurança muito a sério na Meshy, e trabalhamos arduamente para garantir que a Meshy API é segura. Esperamos que os seus dados e os dados dos seus utilizadores estejam seguros connosco. Aqui estão algumas diretrizes gerais para o ajudar a manter os seus dados e pedidos seguros ao utilizar a Meshy API, mas certifique-se também de seguir as diretrizes praticadas na sua equipa ou local de trabalho.

Segurança da Camada de Transporte

Embora os seus dados sejam encriptados em repouso assim que são armazenados na Meshy, a Meshy API utiliza e impõe o TLS, para encriptar os dados em trânsito. Isto significa que todos os pedidos de e para a Meshy API são enviados através de HTTPS, e qualquer pedido feito através de HTTP receberá um código de estado 301 Moved Permanently. Embora não seja recomendado, em alguns casos, se tiver de comunicar através de HTTP, terá de indicar explicitamente ao seu cliente HTTP para seguir os redirecionamentos de HTTP para HTTPS. Aqui estão alguns exemplos:

# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Os redirecionamentos só funcionam para pedidos GET: os clientes HTTP reenviam um POST redirecionado como um GET sem o seu corpo, pelo que deve sempre chamar https:// diretamente ao criar tarefas.

Segurança da chave de API

Uma vez gerada, a chave de API deixa de ser visível no painel, pelo que deve transferi-la e mantê-la em segurança, uma vez que qualquer pessoa que a obtenha pode utilizá-la para comunicar com a Meshy API em seu nome. Se acreditar que a sua chave de API foi comprometida, pode revogá-la a qualquer momento a partir do painel, e assim que for revogada, deixará de ser válida.

Divulgação de segurança

Se acreditar que descobriu um problema de segurança na Meshy API, por favor entre em contacto connosco. Agradecemos a sua divulgação responsável e faremos todos os esforços para reconhecer o seu contributo.