APIs e integrações
Ligue uma aplicação através da API de inferência ou da API de treino de modelos documentada, utilizando credenciais com âmbito definido e as referências atuais de utilização e API.
- Escolher o produto de APIDistinga os pedidos de inferência dos fluxos de treino de modelos.
- Consultar o contratoUtilize a documentação da API e a referência OpenAPI correspondentes.
- Criar uma chave com âmbito definidoGere e guarde em segurança uma chave de API de cliente.
- Integrar e verificarEnvie um pedido documentado e analise a resposta.
- Monitorizar e rodar as chavesConsulte a utilização e revogue ou rode as chaves quando necessário.
Escolher o fluxo de API adequado
A API de inferência processa pedidos de inferência de modelos; a API de treino de modelos documenta um fluxo separado de propostas, tarefas, sessões e artefactos. Não presuma que um endpoint de inferência inicia um treino nem que uma operação de treino está disponível no contrato de inferência. Leia a documentação do produto que pretende utilizar e confirme que o modelo ou a capacidade de treino estão listados. Utilize as estruturas de pedido e resposta publicadas, em vez de deduzir nomes de métodos a partir de um SDK de terceiros que já conheça.
- Determine se a aplicação necessita de inferência ou de treino de modelos.
- Abra a documentação do produto e a referência da API correspondentes.
- Confirme que a capacidade e o modelo pretendidos estão documentados.
Criar e proteger uma chave de API
Crie uma chave de API de cliente na página de chaves de API autenticada e, se a interface permitir escolher âmbitos, selecione apenas os necessários para a integração. O segredo só é apresentado uma vez, por isso guarde-o diretamente num gestor de segredos aprovado; não o inclua no controlo de versões, em registos nem em código do browser. Sempre que possível, identifique as credenciais pela aplicação e pelo ambiente. Utilize credenciais distintas para desenvolvimento e produção, para poder revogar uma sem interromper integrações não relacionadas.
- Abra Chaves de API no espaço de trabalho de cliente autenticado.
- Crie uma chave com o âmbito mais restrito de que necessita.
- Guarde o segredo em segurança e não o inclua no código-fonte nem nos registos.
Implementar de acordo com o contrato documentado
Siga o guia da API relevante quanto à autenticação, ao endpoint, aos campos do pedido, ao tratamento das respostas e aos erros. Mantenha as credenciais do serviço num servidor de confiança, não em código de cliente público. Valide os dados antes de os enviar, trate explicitamente as respostas sem sucesso e evite registar cabeçalhos de autorização ou dados sensíveis dos prompts. Consulte a referência OpenAPI para obter o contrato publicado legível por máquina. Não presuma suporte para streaming, multimédia ou operações nativas do fornecedor, a menos que estejam expressamente indicadas na documentação atual.
- Implemente apenas operações e campos descritos para a API escolhida.
- Mantenha as credenciais no servidor e remova-as dos dados de diagnóstico.
- Trate os erros documentados e guarde os identificadores dos pedidos quando forem fornecidos.
Monitorizar a utilização e gerir credenciais
Depois da integração, consulte a página de utilização para perceber a atividade associada à sua conta e compare-a com os registos da sua aplicação. Investigue alterações inesperadas antes de aumentar o tráfego ou criar credenciais adicionais. Se uma chave puder ter sido exposta, rode-a, atualize o gestor de segredos da aplicação e verifique a integração antes de remover a credencial antiga ainda existente. Revogue as chaves de que já não necessita. Os dados de utilização ajudam a analisar operações, mas não garantem encargos ou capacidade futuros.
- Compare a utilização da plataforma com os registos de pedidos da aplicação.
- Rode uma credencial exposta e verifique a substituição.
- Revogue as chaves não utilizadas e reveja os acessos periodicamente.
Perguntas frequentes
A inferência e o treino de modelos utilizam a mesma API?
Não. São produtos separados, com fluxos de trabalho documentados diferentes. Consulte a referência da capacidade de que necessita.
Onde encontro o contrato de API suportado?
Consulte a documentação do produto e a referência OpenAPI ligadas a partir deste guia. Descrevem a interface publicada atualmente.
Onde devo guardar um segredo de API?
Utilize um gestor de segredos seguro no servidor. Nunca o inclua num repositório, o exponha em código do browser ou o registe em logs.
O que devo fazer se uma chave for exposta?
Rode-a ou revogue-a em Chaves de API, substitua-a no gestor de segredos da aplicação e consulte a utilização recente para detetar atividade inesperada.