Braidrun SDK
Utilize 13 clientes com tipagem segura, que abrangem 12 linguagens, para chamar as APIs de fluxos de trabalho, execuções, artefactos, aprovações e webhooks.
O Braidrun SDK é a coleção oficial de clientes com tipagem segura para a API da plataforma aberta. Encapsula os endpoints de fluxos de trabalho, execuções, artefactos, aprovações humanas e webhooks em métodos e modelos de dados familiares para cada linguagem, para que não tenha de escrever manualmente pedidos HTTP e tipos de resposta.
Clientes suportados
O repositório disponibiliza 13 implementações de cliente que abrangem 12 linguagens. Cada diretório contém um cliente autónomo, com metadados do pacote, modelos de API, testes e documentação completa dos endpoints nessa linguagem.
Servidor e backend
Web e Node.js
Dispositivos móveis e multiplataforma
Cobertura da API
Todos os clientes abrangem as mesmas capacidades públicas, com nomes de métodos adaptados às convenções da respetiva linguagem.
| Capacidade | O que pode fazer |
|---|---|
| workflows | Listar e consultar fluxos de trabalho e iniciar uma execução de forma assíncrona. |
| Executar | Consultar o estado, o histórico e os resultados finais, ou cancelar uma execução ainda em curso. |
| Artefacto | Ler os ficheiros e os metadados dos artefactos produzidos por uma execução. |
| Aprovação manual | Consultar aprovações pendentes e enviar uma decisão de aprovação ou rejeição. |
| Webhook | Registar e gerir webhooks, consultar estatísticas e acionar fluxos de trabalho através de webhooks. |
Início Rápido
- Crie uma chave em «Definições da conta → Chaves de API» e conceda apenas os âmbitos necessários às suas chamadas.
- Escolha o cliente correspondente à sua stack tecnológica e abra o README do respetivo diretório.
- Instale as dependências a partir do código-fonte e configure a chave de API através de uma variável de ambiente.
- Crie um cliente de API e, em seguida, chame primeiro a lista de fluxos de trabalho para verificar a ligação e as permissões.
python -m pip install "git+https://github.com/Braidrun/braidrun-sdk.git#subdirectory=python"import os
import braidrun_sdk
configuration = braidrun_sdk.Configuration(
host="https://braidrun.com",
access_token=os.environ["BRAIDRUN_API_KEY"],
)
with braidrun_sdk.ApiClient(configuration) as client:
workflows = braidrun_sdk.WorkflowsApi(client)
result = workflows.list_workflows()
print(result)Atualmente, o SDK é distribuído através do respetivo repositório de código-fonte no GitHub, e a disponibilidade nos gestores de pacotes específicos de cada linguagem pode variar. Consulte o README do diretório relevante; não pressuponha que todos os clientes foram publicados num repositório público de pacotes.
Autenticação e permissões
Carregue a chave de API iniciada por dyk_ a partir de uma variável de ambiente ou de um serviço de gestão de segredos e utilize um cabeçalho Bearer. Nunca inclua uma chave real no código-fonte, nos registos ou no código frontend do navegador. Cada endpoint continua a verificar o âmbito necessário; um cliente com tipagem segura não concede permissões automaticamente.
O SDK também gera APIs de gestão de webhooks, mas os endpoints de gestão em /api/webhooks utilizam uma sessão do navegador ou uma conta de serviço de administrador e não aceitam as chaves de API padrão, com âmbitos granulares, da plataforma aberta. Os endpoints de acionamento de webhooks podem continuar a utilizar uma chave da plataforma aberta com o âmbito WEBHOOK_TRIGGER.
Quando a API devolver 429, respeite o Retry-After e utilize X-RateLimit-Limit e X-RateLimit-Window para ajustar o ritmo das novas tentativas.
SDK ou motor de fluxos de trabalho?
| Projeto | Adequado para a cena | É executado em |
|---|---|---|
braidrun-sdk | Chame a API da plataforma cloud da Braidrun a partir da sua aplicação, com tipos e modelos específicos da linguagem. | A sua aplicação + plataforma cloud da Braidrun |
braidrun-workflow | Execute fluxos de trabalho YAML no seu próprio ambiente ou incorpore o ambiente de execução num projeto Kotlin/JVM. | Ambientes locais, servidores ou ambientes de CI geridos por si |
Ver a descrição completa de ambos os projetos