API docs by Redocly

Bimer Telemetria

Download OpenAPI specification:

O Bimer Telemetria foi criado com intuito de receber as informações de uso de sistemas e stacks da Alterdata, permitindo acessá-las posteriormente através de uma interface.

Autenticação



Para consumir esse serviço é necessário enviar informações de autenticação. O Bimer Telemetria trabalha com autenticação Digest e, para tal, você deve solicitar de antemão suas credenciais: username e password.

Com suas credenciais, você deverá fazer uma requisição no Endpoint com o padrão de autenticação Digest e o username e password. Todo o restante do tratamento referente aos headers e hash utilizados é feito internamente.

Nota: para maiores informações sobre esse modelo de autenticação, é possível consultar em: https://en.wikipedia.org/wiki/Digest_access_authentication

Métricas

Registrar métrica

Métricas são contratos de eventos isolados, e mesmo que se repitam não possuem nenhum vínculo entre si.

Esse endpoint registra um contrato de métrica, com as informações que você desejar, contendo um padrão mínimo com os atributos necessários. A elaboração do contrato é livre, podendo ser adicionadas novas informações ou até mesmo deixar de preencher atributos não mais necessários.

A API considerará as informações do padrão disponibilizado no exemplo para categorizar sua métrica.

Os campos marcados como obrigatórios só cumprem essa condição caso o objeto em que estão inseridos esteja no JSON.

Por exemplo, se passarmos o objeto "configuracoes" é necessário passar os campos nmsecao, nome e valor. Porém se o contrato contiver apenas os objetos "identificacao" e "sistema", os campos nmsecao, nome e valor não são necessários.



header Parameters
Accept
string
Example: application/json

e.g. application/json

Request Body schema: application/json
object (identificacao)
object (sistema)
object (configuracoes)
object (empresas)

Responses

Request samples

Content type
application/json
{
  • "identificacao": {
    },
  • "sistema": {
    },
  • "configuracoes": {
    },
  • "empresas": {
    }
}