Atualização importante: observe que a API V3 será descontinuada em breve e não receberá mais atualizações ou suporte após a data de término de sua vida útil. Para se beneficiar dos recursos aprimorados e do melhor desempenho, recomendamos enfaticamente a transição para nossa nova API V4. Preparamos uma guia abrangente que detalha as etapas para começar a trabalhar com a V4 para tornar o processo o mais tranquilo possível para você.
O Couchbase Capella oferece uma API pública que permite que os administradores e desenvolvedores integrem e interajam com o Plano de Controle usando uma variedade de linguagens e plataformas de programação. As APIs RESTful têm o objetivo de permitir que os clientes se integrem ao Couchbase Capella e realizem operações como:
-
- Integração e desligamento de usuários
- Gerenciar o ciclo de vida de um banco de dados
- Monitoramento de um banco de dados
Esta postagem do blog mostrará a você como utilizar o Cliente da API do Postman para interagir com a API pública do Couchbase Capella por meio da interface REST.
Observe que este tutorial usa a versão 3 da API pública do Capella. Uma versão renovada da API está sendo desenvolvida e pode introduzir algumas mudanças significativas. Dessa forma, não recomendamos que você use essa versão da API em implementações de produção, pois não garantimos a compatibilidade com versões anteriores dessa versão. No entanto, recomendamos que você avalie a API e solicite feedback sobre os recursos que gostaria de ver na nova versão da API pública.
Pré-requisitos
-
- O Postman é uma ótima ferramenta para interagir com uma API REST. No restante deste tutorial, presumo que você tenha instalado o Postman localmente e que ele esteja pronto para uso. Você pode baixá-lo em postman.com/downloads
- A próxima etapa é fazer o download do arquivo OpenAPI do Couchbase Capella no site do Capella site de documentação.
-
- Você também precisará criar uma chave de acesso e uma chave secreta para usar a API pública. Consulte as instruções sobre como configurar suas chaves aqui.
Criar um novo ambiente Postman
Nesta etapa, você configurará um novo ambiente Postman (um conjunto de variáveis que você pode usar em suas solicitações Postman). A API pública do Couchbase Capella exigirá suas chaves de acesso e secretas.
Certifique-se de nomear as variáveis exatamente como segue:
-
- accessKey contendo sua chave de acesso
- secretKey contendo seu segredo
Provavelmente, é melhor definir esse novo ambiente como o ativo.
Importar a definição da OpenAPI
A próxima etapa é importar o arquivo de definição OpenAPI que você baixou anteriormente. Isso criará uma nova coleção do Postman.
Neste ponto, você tem a coleção e o ambiente configurados no Postman.
Configurar a autenticação
A API pública do Couchbase Capella usa um Portador token para autenticação; cada chamada à API pública deve ser autenticada. Você pode encontrar detalhes sobre os dois cabeçalhos que deve enviar com cada solicitação consultando o documentação oficial em cabeçalhos de segurança.
Para ajudá-lo a começar, temos um script de pré-solicitação do Postman que gera os cabeçalhos necessários com base em suas chaves de acesso e secretas.
Você deve copiar e colar esse código no campo Script de pré-solicitação da coleção. Você pode obter mais informações sobre scripts de pré-solicitação visitando Postman's site de documentação.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
// Pegar as informações do ponto de extremidade atual da solicitação const url = pm.solicitação.url.getPathWithQuery() // Pegar o método da solicitação const método = pm.solicitação.método; // Criar um registro de data e hora const agora = novo Data().getTime(); // Data/hora no passado const ontem = novo Data(); ontem.setDate(ontem.getDate() - 1); // hash SHA-256 const createHash = (carga útil, segredo) => { retorno CryptoJS.HmacSHA256(carga útil, segredo) .toString(CryptoJS.enc.Base64); } // Criar o bearerToken const setToken = (accessKey, hash) => { pm.ambiente.definir("bearerToken", accessKey + ':' + hash); } // Criar o cabeçalho Timestamp const setTimestampheader = (data) => { pm.solicitação.cabeçalhos.adicionar({ chave: "Couchbase-Timestamp", valor: data }); } // Se accessKey e secretKey estiverem definidos, podemos gerar o hash se (pm.ambiente.tem("accessKey") && pm.ambiente.tem("secretKey")) { // Substituir variáveis no URL const URL analisada = pm.variáveis.replaceIn(url); // Gerar a carga útil const carga útil = [método, URL analisada, agora].unir-se("\n"); console.registro("Carga útil", carga útil); // Gerar o hash const hash = createHash(carga útil, pm.ambiente.obter("secretKey")) // Salvar o token em uma variável env setToken(pm.ambiente.obter("accessKey"), hash); // Adicionar o cabeçalho de registro de data e hora à solicitação setTimestampheader(agora); } pm.ambiente.definir("ontem", ontem.toJSON()); pm.ambiente.definir("agora", novo Data().toJSON()); |
Neste ponto, você está pronto para executar suas consultas. A seguir, veremos como executar algumas das consultas Consultas à API pública.
Executar consultas
Como primeiro exemplo, vamos executar o Lista de usuários na pasta de usuários.
Ao executar essa consulta, você perceberá que a resposta está vazia, apesar de haver usuários no sistema. Isso ocorre porque os parâmetros da consulta foram atribuídos a valores padrão incorretos.
Você deve alterar os seguintes parâmetros de consulta: página e por página. No exemplo a seguir, alterarei o página para 1 e o por página para 100 para obter o resultado esperado da API.
É isso aí! Agora você está pronto para descobrir a API pública do Couchbase Capella. Espero que encontre algumas maneiras interessantes de usá-la em seu projeto.
