Como começar com a API - Noções básicas 01
O que é uma API (Interface de programação de aplicações)
Conjunto de regras e protocolos que permitem que diferentes aplicações de software comuniquem entre si. Define como os pedidos e as respostas devem ser estruturados, permitindo que os programadores utilizem funções ou serviços predefinidos sem compreender o seu funcionamento interno.
REST API no IDEA StatiCa Connection - é um serviço web alojado localmente que segue os princípios REST, permitindo que os sistemas comuniquem utilizando métodos HTTP padrão para realizar operações sobre recursos, tipicamente representados em formato JSON.
Recursos e GITHUB
A fonte de exemplos existentes e predefinidos está disponível no nosso GitHub:
Como começar
O tutorial será apresentado em combinação com a linguagem de programação Python. Pode transferir a versão mais recente aqui. Pode utilizar vários Ambientes de Desenvolvimento Integrado (IDE) como ferramentas para uma codificação, depuração e teste eficientes. Seguem-se algumas opções:
Como executar a API
O iniciador da API pode ser encontrado na pasta onde está armazenada a versão mais recente do IDEA StatiCa. Basta executar o ficheiro executável.
Se executar o "IdeaStatiCa.ConnectionRestApi.exe," a janela CMD (Linha de comandos) será apresentada, podendo ver o seu localhost e abrir a aplicação Swagger, que lhe permite ver a estrutura do código para controlar a API. Prima Control + Botão Esquerdo do Rato para abrir o Swagger.
O Swagger em modo online fornece um guia sobre as opções da API para o dimensionamento de ligações.
Como abrir o Python e instalar o pacote da API
Utilizo o PyCharm, que descreve todos os passos. O procedimento é idêntico com as outras ferramentas. Abra o Python e crie um Novo Projeto.
Instale o pacote " ideastatica_connection_api". Comece por abrir o terminal e escreva "pip install ideastatica_connection_api". Ao executar este comando, a biblioteca para a API será instalada.
"pip install ideastatica_connection_api" - funciona para a versão mais recente do IDEA StatiCa. Caso possua versões mais antigas, é necessário especificar a versão exata para invocar a biblioteca de API adequada.
(Por exemplo: "pip install ideastatica_connection_api==25.1.1.923" )
Os passos acima mencionados são obrigatórios e devem ser seguidos corretamente. Caso contrário, a API não funcionará adequadamente.
Abrir um projeto na aplicação de ambiente de trabalho
O objetivo será controlar a simulação e os resultados através da interface Python e ler os resultados diretamente na consola.
Abra a ligação de emenda e execute o cálculo para LE1 e obtenha os resultados. Como pode verificar, todo o conjunto de verificações é satisfeito. Pode prosseguir para o Python.
Script Python
Importe os pacotes que permitirão a utilização do cálculo e a ligação com o URL do localhost.
Código fonte:
## Link with baseUrl
import ideastatica_connection_api.connection_api_service_attacher as connection_api_service_attacher
Configure o registo através da variável "baseUrl," que irá invocar o seu localhost. No segundo passo, associe o caminho absoluto do seu ficheiro IDEA StatiCa Connection.
Código fonte:
## Configure logging
baseUrl = "http://localhost:5000"
## Absolute path into folder with your python script and connection module
project_file_path = r"C:\Users\LukasJuricek\Desktop\API_IDEA\Splice.ideaCon"
print(project_file_path)
Associe o cliente a um serviço já em execução (1). Utilize o bloco try/except - uma vez que o bloco try gera um erro, o bloco except será executado. Na primeira fase, é necessário abrir o projeto (2) e encontrar o ID do projeto, que é único para cada projeto IDEA StatiCa (3). Ao executar o script, pode ler o caminho impresso e o ID único (4).
Código fonte:
with connection_api_service_attacher.ConnectionApiServiceAttacher(baseUrl).create_api_client() as api_client:
try:
## Open the project
openProject = api_client.project.open_project_from_filepath(project_file_path)
## Unique project ID that provide the control over the model
projectId = api_client.project.active_project_id
print(projectId)
Extraia o "connection_ID" que identificará a ligação a calcular (1). Execute a simulação com a variável "calculation_run," que necessita de dois parâmetros obrigatórios indicados entre parênteses (2). Se a simulação for concluída, verá o ID da ligação e a informação de que a análise foi bem-sucedida (3).
Código fonte:
## Opening project that will be calculated
connection = openProject.connections[0]
print(connection)
connection_ID = [connection.id]
## Assigning connection ID
calculation_run = api_client.calculation.calculate(
projectId,
connection_ID
)
print('Finished')
Na fase final, explora-se como imprimir os resultados (1) e como iterar sobre todas as verificações de utilização (2) que são normalmente apresentadas no ambiente de trabalho (3).
Código fonte:
## Postprocessing - extract the unity check of connection
Results = calculation_run[0].result_summary
## Loop over all unity checks like plates, bolts, welds
for results in Results:
print(results.unity_check_message)
except Exception as e:
print("Operation failed : %s\n" % e)
Conclusão
Adquiriu experiência com a API para o dimensionamento de ligações. Aprendeu quais as ferramentas que precisam de ser instaladas, como ligar o serviço REST API e como utilizar o código Python para obter os resultados.