Skip to content

rdigaum/trafficpeak-query-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TrafficPeak Query via API

Descrição

TrafficPeak Query via API é um projeto em Python que permite obter um token JWT e executar Queries SQL nos endpoints do produto TrafficPeak da Hydrolix, utilizando autenticação Bearer e facilitando a extração de logs via API.

Referências da API - Akamai Ttraffic Peak

Pré-requisitos

Antes de iniciar, certifique-se de ter o seguinte instalado em seu ambiente:

  • Python 3.7 ou superior
  • pip instalado

Instalação

  1. Clone o repositório:

    git clone https://github.com/rdigaum/trafficpeak-query-api.git
    cd trafficpeak-query-api
  2. Instale as dependências do projeto:

    pip install -r requeriments.txt

Configuração

O projeto requer arquivos de configuração para armazenar credenciais e endppwdoints:

  1. Crie o arquivo .secret e adicione suas credenciais:

    USERNAME=seu-usuario
    PASSWORD=sua-senha
  2. Crie o arquivo properties e defina os endpoints da API:

    TOKEN_ENDPOINT=hostname.trafficpeak/config/v1/login/
    QUERY_ENDPOINT=hostname.trafficpeak/query

Uso

O script suporta duas opções: obter o token JWT ou executar uma consulta na API.

Gerar apenas o token JWT

Para obter um token JWT válido, execute:

python queryRun.py get_token

Executar uma query

Para executar uma consulta SQL na API, utilize:

python queryRun.py run_query --query "SELECT reqTimeSec, reqHost, reqPath, securityRules FROM akamai.logs WHERE reqHost = 'hostname' LIMIT 15 FORMAT JSON"

Estrutura do Projeto

trafficpeak-query-api/
│── queryRun.py       # Script principal para autenticação, coleta do token e execução de queries
│── requirements.txt   # Dependências do projeto em Python
│── .gitignore        # Arquivos ignorados pelo Git (credenciais e logs)
│── .secret          # Credenciais - definir o usuário e senha para obter o token
│── properties       # Endpoints da API com base nas referência da documentação da TrafficPeak ## Referência de API
│── README.md        # Documentação do Projeto

Observações

  • Certifique-se de não enviar os arquivos .secret e properties para o repositório, pois eles contêm informações sensíveis.
  • Utilize um ambiente virtual (venv) para evitar conflitos com pacotes globais do Python:
    python -m venv venv
    source venv/bin/activate  # No Linux/Mac
    venv\Scripts\activate  # No Windows
    pip install -r requirements.txt

Contribuição

Sinta-se à vontade para abrir issues e enviar pull requests para melhorias no projeto!

Licença

Este projeto é distribuído sob a licença MIT.

About

Projeto para facilitar o uso de obtenção de Token e a execução de Queries nas API do Akamai - TrafficPeak

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages