Como acessar a Analytics API Malga

Você pode utilizar a sua aplicação ou o playground GraphiQL para interagir com a API em tempo real. Através dela, é possível visualizar os objetos, lista de campos e realizar as queries. A autenticação para todas as chamadas da API é feita através de headers HTTP, sendo necessário informar seu identificador de cliente na Malga e a chave secreta de acesso. Todas as requisições em GraphQL devem ser enviadas ao endpoint HTTP utilizando o método POST.

Ambientes

Sandbox:

curl --location --request POST 'https://api.dev.malga.io/v1/graphql' \
--header 'X-Client-Id: YOUR_CLIENT_ID' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{YOUR_QUERY}'

Produção:

curl --location --request POST 'https://api.malga.io/v1/graphql' \
--header 'X-Client-Id: YOUR_CLIENT_ID' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{YOUR_QUERY}'

Se você ainda não possui uma conta de sandbox na Malga, você pode criá-la aqui e imediatamente obterá as credenciais para acesso ao ambiente de testes.

Credenciais

X-Client-ID

Identificador único da sua conta na Malga. Deve ser enviado no header obrigatoriamente em todas as requisições feitas à API.

Security Scheme Type	API Key
Header parameter name	X-Client-ID

X-Api-Key

Sua chave de acesso à API. Funciona em par com o client-id e deve ser enviada no header obrigatoriamente em todas as requisições feitas à API. A chave precisa ter o escopo graphql ou *:

A chave secreta gerada no Dashboard no credenciamento da conta já tem escopo * e pode ser usada diretamente.
Para uma chave só da Analytics API, crie uma chave pública via POST /v1/auth com o escopo graphql. Use o publicKey retornado no header X-Api-Key.

curl --location --request POST 'https://api.malga.io/v1/auth' \
--header 'X-Client-Id: YOUR_CLIENT_ID' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scope": ["graphql"],
    "expires": 0
}'

Se a chave não tiver graphql nem *, a chamada em /v1/graphql retorna 403.

Security Scheme Type	API Key
Header parameter name	X-Api-Key

Exemplo de requisição autenticada:

curl --location --request POST 'https://api.malga.io/v1/graphql' \
    --header 'X-Client-Id: YOUR_CLIENT_ID' \
    --header 'X-Api-Key: YOUR_API_KEY' \
    --header 'Content-Type: application/json' \
    --data-raw '{YOUR_QUERY}'

Autenticação no Playground GraphiQL

Para utilizar o Playground e realizar os testes na API, é necessário inserir o seu X-Client-Id e X-Api-Key no campo Headers, localizado na janela inferior do ambiente, conforme o exemplo abaixo:

​Ambientes

​Credenciais

​X-Client-ID

​X-Api-Key

​Autenticação no Playground GraphiQL

Ambientes

Credenciais

X-Client-ID

X-Api-Key

Autenticação no Playground GraphiQL