L'API di Market Dojo

L'API di Market Dojo

Qual è il problema che stai affrontando?

Vorrei connettermi all'API di Market Dojo. Come posso fare?

Soluzione

È possibile accedere a Market Dojo a livello programmatico tramite API.

Passaggi

  1. Accedi a Market Dojo

  2. Vai alla pagina del tuo profilo, prendi nota del tuo indirizzo e-mail e della chiave API di Market Dojo

  3. Vai su https://secure.marketdojo.com/api/v1/documentation  

  4. Esamina gli endpoint disponibili per comprendere il funzionamento dell'API.

  5. Tieni presente che puoi sperimentare con l'API direttamente dalla pagina della documentazione.

Quali sono le API di reporting?

Market Dojo offre una serie di endpoint API progettati per l'utilizzo con strumenti di reporting come Power BI.

Oltre agli endpoint elencati di seguito, la documentazione relativa agli endpoint API v1 è disponibile all'indirizzo https://gl.marketdojo.com/api/v1/documentation

Utilizzo delle API di reporting

Le richieste devono essere indirizzate a:

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

- il dominio configurato della tua azienda (ad esempio, https://acme.marketdojo.com o https://procurement.acme.com).


Le richieste con un'intestazione host per qualsiasi altro dominio vengono bloccate.


Le API di reporting accettano 2 parametri standard:

email : l'indirizzo email dell'utente che accede all'endpoint

api_key : la chiave API dell'utente (reperibile sulla pagina del profilo nell'applicazione Market Dojo).


Se si utilizzano gli endpoint dalla riga di comando, potrebbe essere necessario racchiudere l'URL tra virgolette.


per esempio

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


I risultati vengono restituiti in formato JSON.

Cose da controllare

  • L'utente è membro del gruppo (predefinito)? In caso contrario, riceverà un errore 403.

Come ottenere una chiave API

Per utilizzare l'API è necessaria una chiave API.

Segui le istruzioni qui per ottenere la tua chiave API.

Se non visualizzi l'opzione per creare o visualizzare la tua chiave API, chiedi al tuo superhost di abilitare l'API nella pagina Amministrazione > Integrazioni.


Endpoint API di reporting disponibili

Aziende

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


Questo endpoint restituirà informazioni sull'azienda dell'utente.

Utenti

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


Questo endpoint restituirà informazioni su tutti gli utenti dell'azienda.

Contratti

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



Questo endpoint restituirà i dettagli dei contratti che l'utente può visualizzare.

Eventi

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


Questo endpoint restituirà i dettagli degli eventi che l'utente può visualizzare.

Questionario

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


Questo endpoint restituirà i dettagli di un questionario, comprese le risposte ricevute.

NOTA: :id deve essere sostituito con l'ID (un numero) del questionario.

Partecipanti SIM

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


Questo endpoint restituirà i dettagli dei partecipanti a un evento di onboarding dei fornitori.


SRM

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


Questo endpoint restituirà i dettagli della suite SRM di un utente. Informazioni come le attività e gli eventi relativi a srm_accounts e srm_contacts.