Quais são as APIs de relatório?

O Market Dojo fornece uma série de endpoints de API projetados para uso com ferramentas de geração de relatórios, como o Power BI.

Além dos endpoints listados abaixo, a documentação dos endpoints da API v1 pode ser encontrada em https://gl.marketdojo.com/api/v1/documentation

Utilizando as APIs de relatório

Os pedidos devem ser feitos para:

- https://secure.marketdojo.com, ou

- o domínio configurado da sua empresa (por exemplo, https://acme.marketdojo.com ou https://procurement.acme.com).

Solicitações com um cabeçalho de host para qualquer outro domínio serão bloqueadas.

As APIs de relatório utilizam 2 parâmetros padrão:

e-mail : o e-mail do usuário que está acessando o endpoint

api_key : a chave de API do usuário (pode ser encontrada na página de perfil dele no aplicativo Market Dojo)

Ao utilizar os endpoints a partir da linha de comando, pode ser necessário colocar a URL entre aspas.

curl ' https://secure.marketdojo.com/api/v2/reports/contracts?email=email&api_key=api_key '

Os resultados são retornados em formato JSON.

Coisas a verificar

• O usuário é membro do grupo (padrão)? Caso contrário, receberá um erro 403.

Como obter uma chave de API

É necessária uma chave de API para usar a API.

Siga as instruções aqui para obter sua chave de API.

Caso não veja a opção para criar ou visualizar sua chave de API, solicite ao seu superhost que habilite a API na página Admin > Integrações.

Endpoints de API de relatório disponíveis

Empresas

https://secure.marketdojo.com/api/v2/reports/companies?email=email&api_key=key

Este endpoint retornará informações sobre a empresa do usuário.

Usuários

https://secure.marketdojo.com/api/v2/reports/users?email=email&api_key=key

Este endpoint retornará informações sobre todos os usuários da empresa.

Contratos

https://secure.marketdojo.com/api/v2/reports/contracts?email=email&api_key=key

Este endpoint retornará detalhes dos contratos que o usuário tem acesso para visualizar.

Eventos

https://secure.marketdojo.com/api/v2/reports/events?email=email&api_key=key

Este endpoint retornará detalhes dos eventos que o usuário tem acesso para visualizar.

Questionário

https://secure.marketdojo.com/api/v2/reports/questionnaires/:id?email=email&api_key=key

Este endpoint retornará detalhes de um questionário, incluindo as respostas recebidas.

NOTA: :id deve ser substituído pelo id (um número) do questionário.

Participantes do SIM

https://secure.marketdojo.com/api/v2/reports/sim_participants?email=email&api_key=key

Este endpoint retornará detalhes dos participantes em um evento de integração de fornecedores.

SRM

https://secure.marketdojo.com/api/v2/reports/srm?email=email&api_key=key

Este endpoint retornará detalhes do conjunto de ferramentas SRM de um usuário. Informações como srm_accounts, srm_contacts, atividades e eventos.