Ao criar novos registros de dados ou modificar dados existentes no back end, passar a marca de tempo atual pode ser um componente importante a ter. Felizmente, o Postman, uma ferramenta de API, possui os recursos necessários para fornecer marcas de tempo em solicitações.
Com o Apidog, você pode fazer qualquer coisa relacionada a APIs, desde a construção até a documentação. Para ver quais outras funcionalidades o Apidog oferece, clique no botão abaixo para começar. 👇
Este artigo mergulha em dois métodos eficazes para incorporar a marca de tempo atual nas suas solicitações do Postman: utilizando a variável de timestamp predefinida e aproveitando o poder dos scripts de pré-solicitação.
O que é Postman?
Para desenvolvedores, Postman é uma caixa de ferramentas de API popular e confiável. Ele os capacita não apenas a criar e testar APIs, mas também a documentá-las. Ao simplificar todo o processo de desenvolvimento de API, o Postman torna o mundo, muitas vezes complexo, das APIs mais acessível e compreensível.
O que é uma marca de tempo atual?
Uma marca de tempo atual refere-se a uma representação do exato momento em que um evento ocorre. Existem alguns formatos nos quais as marcas de tempo podem ser expressas:
Timestamp Unix (Segundos Desde a Época)
Este formato representa o número de segundos que se passaram desde um ponto específico no tempo, tipicamente 1º de janeiro de 1970, 00:00:00 UTC. Ele oferece um formato compacto e legível por máquina para APIs.
Formato ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ):
Este formato padronizado expressa a data e hora de uma maneira legível por humanos e por máquinas. Inclui o ano, mês, dia, hora, minuto, segundo, milissegundos (opcional) e um indicador de fuso horário (Z para UTC). Este formato facilita a comunicação clara e evita confusão entre diferentes sistemas.
Importância das Marcas de Tempo em APIs
- Precisão e Ordenação: Elas estabelecem o momento exato em que um evento ocorreu dentro de uma interação de API. Isso ajuda a rastrear os horários de criação ou modificação de dados, garantindo sequências precisas e evitando confusões sobre quando as coisas aconteceram.
- Atualidade dos Dados: As marcas de tempo podem indicar quão recentes os dados são. Isso é crucial para cenários onde informações em tempo real ou dados com uma vida útil limitada estão envolvidos. Imagine uma API de cotações de ações - saber a marca de tempo ajuda a determinar se a cotação reflete a situação atual do mercado.
- Identificação de Erros: As marcas de tempo podem ajudar na solução de problemas de erros. Ao comparar marcas de tempo em solicitações e respostas, os desenvolvedores podem identificar possíveis atrasos ou precisar onde ocorreram problemas no fluxo de comunicação.
- Controle de Versão e Auditoria: As marcas de tempo podem ser usadas para rastrear alterações de versão de API ou registrar atividade de usuários. Isso facilita os retrocessos para versões anteriores, se necessário, e ajuda a manter um registro do uso da API para fins de auditoria.
Guia passo a passo sobre como passar a marca de tempo atual em uma solicitação de API do Postman
Passo 1 - Criar uma Conta do Postman
Criar uma nova conta do Postman (somente se você não tiver uma) e começar a baixar o aplicativo Postman para o seu dispositivo. O aplicativo oferece mais recursos do que sua versão na web.
Passo 2 - Criar uma Nova Solicitação de API no Postman
Depois de instalar o Postman, crie uma nova solicitação clicando no botão New no canto superior esquerdo da janela do Postman. Selecione HTTP Request para criar uma nova solicitação, conforme mostrado na imagem acima.
Passo 3 - Inserir Método e Detalhes da API
Em seguida, você precisa incluir os detalhes da solicitação da API que deseja criar. Deve incluir componentes como a URL, métodos HTTP, e parâmetros adicionais que a API exigirá.
Passo 4 - Abrir a Seção Pre-Request Script
No seu API completado, procure pela seção Pre-request script, conforme mostrado na imagem acima.
Passo 5 - Inserir o Código Necessário para Incluir a Marca de Tempo
Nesta seção vazia sob a aba Pre-request Script, insira as seguintes linhas de código para que você possa incluir a marca de tempo.
var moment = require('moment');
pm.environment.set('currentdate', moment().format(("YYYY-MM-DD HH:MM:SS")));
Para este exemplo em particular, a marca de tempo será armazenada na variável currentdate usando o método pm.environment.set.
Passo 6 - Incluir a Variável currentdate como uma Variável de Solicitação
Por fim, certifique-se de incluir a variável de marca de tempo na API definindo o parâmetro da API. Agora, toda vez que você enviar uma solicitação nessa API específica, você deve conseguir encontrar a marca de tempo quando a solicitação foi enviada!
Apidog - Fornecendo os Melhores Detalhes por Padrão
Apidog é uma plataforma abrangente de desenvolvimento de API que pode ser uma excelente alternativa ao Postman. Com o Apidog, você não precisa mais se preocupar com os pequenos detalhes - todos eles foram considerados pelo Apidog - então dê uma olhada nas seções abaixo para ver como visualizar esses detalhes da API!
Incluindo Marca de Tempo no Cabeçalho da Solicitação no Apidog
Para incluir a marca de tempo atual no cabeçalho da solicitação da API, siga os passos abaixo!
Para adicionar a marca de tempo atual ao cabeçalho da solicitação de uma API, prepare as seguintes linhas de código para serem coladas em um script personalizado na seção Pre Processors, como mostrado na imagem acima.
var timestamp = new Date().getTime();
pm.environment.set("timestamp", timestamp);
Uma vez que você tenha inicializado a variável de timestamp, certifique-se de adicionar a variável como um parâmetro de consulta. Veja a imagem acima como referência.
Visualizando Marca de Tempo e Mais na Solicitação de API do Apidog
Com o Apidog, você pode encontrar mais do que apenas a marca de tempo automatizada, você também pode visualizar outros detalhes mais finos relacionados à API, como cookies e o formato cru da solicitação. Com o Apidog, você pode solucionar problemas de suas APIs com precisão para garantir que suas APIs estejam prontas para implantação.
Você também pode considerar fazer testes de carga de API para explorar ainda mais sua API e garantir que a API seja à prova de falhas!
Conclusão
Incorporar marcas de tempo em suas solicitações do Postman desbloqueia uma variedade de benefícios. Quer você precise de rastreamento preciso de dados, verificação da atualidade da solicitação ou identificação de erros simplificada, as marcas de tempo permitem que você trabalhe com APIs de forma mais eficaz. Ao aproveitar a variável predefinida ou scripts de pré-solicitação, você pode integrar marcas de tempo em seu fluxo de trabalho sem problemas.
Lembre-se de consultar a documentação da API para garantir que você esteja utilizando o formato apropriado para comunicação e clareza de dados otimizados. Com marcas de tempo à sua disposição, você pode elevar sua experiência de teste e desenvolvimento de API no Postman.
