Aplicações e chaves
Uma aplicação do Echo representa um consumidor ou fornecedor no seu espaço de trabalho. Não é uma pessoa a iniciar sessão no Maestro. As suas chaves eck_ permitem usar APIs específicas do Echo em automações sem reutilizar a sessão de um utilizador.
Registe a aplicação
Abra Aplicações no Maestro, crie a aplicação e adicione as associações a contratos. Escolha Consumes para uma operação que chama ou Provides para uma que fornece e selecione a versão acordada. Criar ou alterar aplicações e associações, ou emitir chaves, faz parte do Echo Pro e Pro AI e requer a permissão Echo/ManageHosting no grupo MockServers. Num plano pago, esta permissão é atribuída por omissão ao administrador da organização, que a pode dar a outro papel. No Free, a entrada desaparece do menu, mas a ligação direta continua a abrir a lista de aplicações e chaves existentes e a permitir revogar uma chave exposta com a permissão Echo/MockServers.
Dê a cada chave as permissões necessárias
| Scope | Permite | Não permite |
|---|---|---|
ReadBoundContracts |
Ler contratos consumidos associados à aplicação e as alterações de compatibilidade | Publicar versões ou ler todos os contratos do espaço de trabalho |
PublishOwnedContracts |
Publicar versões de contratos existentes com associação Provides à aplicação |
Criar contratos, assumir propriedade ou publicar contratos de outra aplicação |
ServeMocks |
Obter regras de mocks ativos partilhados pelas equipas do espaço de trabalho | Obter mocks pessoais, gerir a hospedagem ou permitir publicação de contratos |
RunCollections |
Listar e obter coleções de equipa ativas, pedidos e ambientes para a CLI | Ler espaços pessoais, editar coleções ou executar pedidos no servidor Echo |
ServeMocks não se limita às associações a contratos desta aplicação. Lê regras de mocks partilhados no espaço de trabalho; não exige que esses mocks tenham hospedagem pública, mas o feed de regras faz parte do Echo Pro e Pro AI. Num plano gratuito, uma chave já emitida pode continuar a ler os contratos associados se tiver ReadBoundContracts, mas o pedido de regras é recusado. Use chaves separadas para o CI do consumidor e para a publicação do fornecedor.
Use uma chave com a CLI de coleções
RunCollections dá à CLI acesso às coleções de equipa elegíveis da organização da aplicação. Não se limita às associações da aplicação a contratos. Os espaços pessoais, as coleções arquivadas e as equipas inativas ficam excluídos. O conjunto obtido inclui pedidos e ambientes; trate a chave e os ficheiros resultantes como credenciais do trabalho dessa equipa.
A CLI envia Authorization: Bearer com a chave eck_ à API do Echo, obtém a coleção e executa os pedidos na máquina que executa a ferramenta. Este scope não agenda uma execução alojada nem envia os resultados ao servidor. Consulte automação e testes.
Chaves ativas já emitidas com ReadBoundContracts e PublishOwnedContracts podem continuar as operações de contratos no Free enquanto as associações forem válidas. Isso não disponibiliza o feed pago de mocks nem permite emitir novas chaves.
Emita e guarde uma chave
- Abra as chaves da aplicação, crie uma chave e selecione apenas os scopes necessários.
- Descreva a sua finalidade e escolha uma validade.
- Copie imediatamente o segredo completo. Só é apresentado uma vez; as listas seguintes mostram o prefixo e os metadados.
- Guarde-o nos segredos do CI, no ambiente ou num cofre. Nunca o inclua num commit, código de browser, captura de ecrã ou URL.
Os exemplos dos pacotes usam variáveis de ambiente. Os pacotes enviam a chave à API, não ao URL da hospedagem pública do mock. O identificador público de um mock publicado é um mecanismo de acesso separado.
Substitua e revogue
Para substituir uma credencial, crie outra, atualize o processo consumidor, verifique-o e revogue a chave antiga. Revogue uma chave perdida ou exposta na lista de chaves da aplicação; gere outra em vez de tentar recuperar o segredo. Mesmo sem plano pago, pode abrir a lista de Aplicações no Maestro pela ligação direta, listar as chaves e revogar uma com Echo/MockServers. Emitir uma chave nova para a substituir requer voltar a ter Echo Pro ou Pro AI e Echo/ManageHosting.
A revogação impede futuros acessos autenticados à API. Não apaga regras já guardadas em cache pelo Mock.Client ou Mock.Server: uma atualização falhada mantém o último retrato. Para esse processo deixar de usar mocks imediatamente, desative a interceção ou pare-o e trate a cache explicitamente.
Para desativar um URL da hospedagem pública ou trocar o seu identificador, use o painel descrito em hospedagem pública de mocks. Revogar uma chave eck_ não desativa esse URL.