Aplicações e chaves
Uma aplicação do Echo representa um consumidor ou fornecedor no seu espaço de trabalho. Não é uma pessoa entrando no Maestro. Suas chaves eck_ permitem usar APIs específicas do Echo em automações sem reutilizar a sessão de um usuário.
Registre a aplicação
Abra Aplicações no Maestro, crie a aplicação e adicione os vínculos com contratos. Escolha Consumes para uma operação que ela chama ou Provides para uma que fornece e selecione a versão acordada. Criar ou alterar aplicações e vínculos, ou emitir chaves, faz parte do Echo Pro e Pro AI e exige a permissão Echo/ManageHosting no grupo MockServers. Em um plano pago, essa permissão é concedida por padrão ao administrador da organização, que pode atribuí-la a outro papel. No Free, a entrada desaparece do menu, mas o link direto continua abrindo a lista de aplicações e chaves existentes e permite 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 vinculados à 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 vínculo Provides à aplicação |
Criar contratos, assumir propriedade ou publicar contratos de outra aplicação |
ServeMocks |
Obter regras de mocks ativos compartilhados pelas equipes do espaço de trabalho | Obter mocks pessoais, gerir a hospedagem ou permitir publicação de contratos |
RunCollections |
Listar e obter coleções de equipe ativas, requisições e ambientes para a CLI | Ler espaços pessoais, editar coleções ou executar requisições no servidor Echo |
ServeMocks não se limita aos vínculos com contratos dessa aplicação. Lê regras de mocks compartilhados 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. No plano gratuito, uma chave já emitida pode continuar lendo os contratos vinculados se tiver ReadBoundContracts, mas a requisição das regras é recusada. 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 equipe elegíveis da organização da aplicação. Não se limita aos vínculos da aplicação com contratos. Espaços pessoais, coleções arquivadas e equipes inativas ficam de fora. O conjunto obtido inclui requisições e ambientes; trate a chave e os arquivos resultantes como credenciais do trabalho dessa equipe.
A CLI envia Authorization: Bearer com a chave eck_ à API do Echo, obtém a coleção e executa suas requisições na máquina que está rodando a ferramenta. Esse scope não agenda uma execução hospedada nem envia os resultados ao servidor. Consulte automação e testes.
Chaves ativas já emitidas com ReadBoundContracts e PublishOwnedContracts podem continuar suas operações de contratos no Free enquanto os vínculos forem válidos. Isso não libera 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 sua finalidade e escolha uma validade.
- Copie imediatamente o segredo completo. Ele só aparece uma vez; as listas seguintes mostram o prefixo e os metadados.
- Guarde-o nos segredos do CI, no ambiente ou em um cofre. Nunca o inclua em um commit, código de navegador, captura de tela ou URL.
Os exemplos dos pacotes usam variáveis de ambiente. Os pacotes enviam a chave à API, não à 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, você pode abrir a lista de Aplicações no Maestro pelo link direto, listar as chaves e revogar uma com Echo/MockServers. Emitir uma nova chave para substituí-la exige 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 que falha mantém o último retrato. Para esse processo deixar de usar mocks imediatamente, desative a interceptação ou pare-o e trate o cache explicitamente.
Para desativar uma URL da hospedagem pública ou trocar seu identificador, use o painel descrito em hospedagem pública de mocks. Revogar uma chave eck_ não desativa essa URL.