API Reference

‎Integração técnica

Informações técnicas para desenvolver a integração com a API Glass Data.

Endpoint

A integração deve ser desenvolvida exclusivamente via backend, utilizando a API REST hospedada no endereço https://api.glassdata.io.

Formato

As requisições nos métodos POST e PATCH devem ser enviadas no formato JSON, usando o cabeçalho Content-Type: application/json.

A resposta da requisição será enviada também no formato JSON.

Autenticação

Para autenticar sua requisição, utilize o o padrão Basic Auth utilizando o ID como usuário e a chave secreta como senha. Teste sua credencial executando o seguinte comando no terminal (necessário curl instalado):

$ curl https://api.glassdata.io/account -u KEY_ID:KEY_SECRET

Se a chave for válida, você receberá o ID da conta atual:

{"account":{"id":"0628fd01-038f-7000-9345-4aaefbe9c6b3"}}

Parabéns! Sua chave está funcionando! 🎉

📘

Faça testes diretamente na documentação

Você também pode utilizar sua chave diretamente na documentação dos métodos da API para realizar testes rápidos e validar requisições e respostas.

Status da plataforma

Para verificar a disponibilidade e a agenda de manutenções da plataforma, acesse https://status.glassdata.io.

Simulando um score

Você pode simular os diferentes tipos de retorno da API de detecção de bots com os seguintes passos:

  1. Certifique-se que você está usando uma chave de API de uma conta de testes. No painel de administração, acesse Configurações > Dados da conta e verifique o se o Modo do ambiente é Testes.
  2. No método POST /payments preencha o campo user.id com a string test_ no início, por exemplo: test_1234.
  3. Envie um valor no campo amount com qualquer número de centavos. Os 2 dígitos dos centavos serão usados no score simulado. Por exemplo, se você enviar 200.59, o score simulado será 0.59.

No resultado da análise, a recomendação do campo analyses.bot_behaviour.action será fornecida de acordo com a configuração de limites no painel (Configurações > Análises). Se qualquer um dos requisitos acima não for cumprido, a plataforma irá calcular o score normalmente.