Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.malga.io/llms.txt

Use this file to discover all available pages before exploring further.

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 devendo ser enviado no header obrigatoriamente em todas as requisições feitas à API. 
Security Scheme Type	API Key
Header parameter name	X-Client-ID
Exemplo de requisição autenticada: 
curl --location --request GET 'https://api.malga.io/v1/graphql' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>' \
    ...

​
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 Headers localizado na janela inferior do ambiente, conforme o exemplo abaixo: Autenticação no Playground GraphiQL