Integração com LabArchives

Use as APIs do LabArchives apenas a partir de páginas de métodos atuais e oficiais. A documentação pública é um caderno compartilhado, não uma referência de SDK versionada, portanto, verifique a página específica imediatamente antes de implementar uma operação remota.

Escolha a Superfície Correta

Não combine estas interfaces:

• API ELN Legada: árvores de cadernos, entradas, anexos, usuários, pesquisas, exportações e funções de licença de site. Ela usa hosts regionais *api.labarchives.com, caminhos /api/<class>/<method>, XML para muitas respostas e parâmetros de consulta assinados.
• API de Inventário v1: inventário, tipos de itens, pedidos, locais de armazenamento e fornecedores. Ela documenta caminhos relativos /public/v1/..., esquemas de resposta JSON e cabeçalhos de solicitação X-LabArchives-* assinados.
• Integrações de produtos: Jupyter, REDCap, Protocols.io, GraphPad Prism, SnapGene, Geneious e outros são fluxos de trabalho de UI ou de arquivos específicos do produto. Eles não são evidências de uma API geral do LabArchives OAuth 2.0.

Leia references/api_reference.md antes de escrever código de API e references/integrations.md antes de automatizar uma integração anunciada.

Acesso e Credenciais

O acesso à API do desenvolvedor LabArchives ELN é uma capacidade Enterprise. O FAQ atual de Inventário limita o acesso à API de Inventário a licenciados Enterprise e Enterprise Plus e requer uma conta de Inventário com permissão de API. Entre em contato com a equipe LabArchives da instituição ou com o suporte LabArchives para obter acesso e a documentação de desenvolvimento fornecida com ele.

Os nomes de ambiente abaixo são convenções desta skill, não padrões definidos pelo fornecedor:

• LABARCHIVES_ELN_API_URL — uma URL exata da API ELN regional terminando em /api
• LABARCHIVES_ACCESS_KEY_ID — ID da Chave de Acesso emitida pelo LabArchives (akid)
• LABARCHIVES_ACCESS_PASSWORD — segredo de assinatura HMAC
• LABARCHIVES_USER_ID — UID persistente opcional vinculado a esse ID da Chave de Acesso
• LABARCHIVES_INVENTORY_LAB_ID — necessário para solicitações de Inventário com escopo de laboratório; omitido durante a descoberta de laboratório GET /public/v1/users/me

Mantenha os segredos no ambiente do processo ou em um gerenciador de segredos aprovado. Não os coloque em YAML, código-fonte, argumentos de linha de comando, prompts, logs, cadernos ou arquivos .env commitados. As ferramentas incluídas nunca procuram arquivos .env.

Deste diretório de skill:

uv run scripts/setup_config.py regions
uv run scripts/setup_config.py check --require-user-id

setup_config.py valida apenas a estrutura do endpoint e a presença de variáveis nomeadas; ele não autentica, persiste ou imprime credenciais. Veja references/authentication_guide.md.

Endpoints Regionais

Os hosts de login do navegador e os hosts de API são diferentes. A visão geral oficial da API ELN lista atualmente hosts de API dos EUA/resto do mundo, Austrália/Nova Zelândia, Reino Unido, Europa fora do Reino Unido e Canadá. O centro de ajuda lista separadamente os cinco hosts regionais de login do navegador.

Use setup_config.py regions para a lista de permissões atual e a tabela completa no guia de autenticação. Nunca construa uma URL de API a partir de uma URL de login do navegador.

A visão geral do Inventário publica https://iapi.labarchives.com como seu URL base da API; anexe a rota documentada /public/v1/.... Nenhuma tabela de URL base regional é publicada lá. Confirme qualquer implantação regional com a instituição/fornecedor; não transforme um host de login do navegador do Inventário em um nome de host de API.

Modelo de Autenticação

Solicitações ELN

O algoritmo oficial é totalmente documentado:

1. Defina expires para o tempo de época Unix atual em milissegundos, ajustado para a diferença do relógio do servidor, se necessário. Apesar do nome, não é um tempo de expiração futuro.
2. Concatene, sem separadores: <Access Key ID><API method name><expires>.
3. Calcule HMAC-SHA-512 usando a Senha de Acesso como chave.
4. Codifique em Base64 o resumo.
5. Codifique em URI essa assinatura e envie akid, expires e sig como os parâmetros de consulta documentados.

Para chamadas ELN comuns, a entrada da assinatura é apenas o nome do método, não a classe da API. A autorização do usuário é um caso especial documentado: assinar o redirecionamento api_user_login usa a URI de redirecionamento não codificada em vez de um nome de método.

Solicitações da API de Inventário v1

O Inventário compartilha o algoritmo HMAC, mas assina a rota relativa exata, incluindo parâmetros de caminho resolvidos e excluindo a string de consulta. Sua página de autenticação documenta estes cabeçalhos:

• X-LabArchives-UId
• X-LabArchives-AKId
• X-LabArchives-LabId

…