Jakie są interfejsy API raportowania

Market Dojo udostępnia szereg punktów końcowych API przeznaczonych do użytku z narzędziami do raportowania, takimi jak Power BI.

Oprócz punktów końcowych wymienionych poniżej dokumentację punktów końcowych interfejsu API v1 można znaleźć pod adresem https://gl.marketdojo.com/api/v1/documentation

Korzystanie z interfejsów API raportowania

Prośby należy kierować do:

- https://secure.marketdojo.com lub

- skonfigurowana domena Twojej firmy (np. https://acme.marketdojo.com lub https://procurement.acme.com).

Żądania zawierające nagłówek hosta dla jakiejkolwiek innej domeny są blokowane.

Interfejsy API raportowania przyjmują 2 standardowe parametry:

e-mail : adres e-mail użytkownika uzyskującego dostęp do punktu końcowego

api_key : klucz API użytkownika (można go znaleźć na stronie jego profilu w aplikacji Market Dojo)

W przypadku korzystania z punktów końcowych z wiersza poleceń konieczne może okazać się ujęcie adresu URL w cudzysłów.

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

Wyniki zwracane są w formacie JSON.

Rzeczy do sprawdzenia

• Czy użytkownik jest członkiem grupy (domyślnej), jeśli nie, otrzyma błąd 403

Uzyskiwanie klucza API

Aby korzystać z API wymagany jest klucz API.

Aby uzyskać klucz API, postępuj zgodnie z podanymi tutaj instrukcjami .

Jeśli nie widzisz opcji utworzenia lub wyświetlenia klucza API, poproś swojego supergospodarza o włączenie API na stronie Administracja > Integracje.

Dostępne punkty końcowe interfejsu API raportowania

Firmy

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

Ten punkt końcowy zwróci informacje o firmie użytkownika.

Użytkownicy

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

Ten punkt końcowy zwróci informacje o wszystkich użytkownikach w firmie.

Umowy

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

Ten punkt końcowy zwróci szczegóły umów, do których użytkownik ma dostęp w celu przeglądania.

Wydarzenia

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

Ten punkt końcowy zwróci szczegóły zdarzeń, do których użytkownik ma dostęp w celu przeglądania.

Kwestionariusz

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

Ten punkt końcowy zwróci szczegóły kwestionariusza, w tym otrzymane odpowiedzi.

UWAGA: :id należy zastąpić identyfikatorem (numerem) kwestionariusza.

Uczestnicy SIM

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

Ten punkt końcowy zwróci szczegóły uczestników wydarzenia wprowadzającego Dostawcę.

SRM

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

Ten punkt końcowy zwróci szczegóły pakietu SRM użytkownika. Informacje takie jak srm_accounts, srm_contacts, aktywności i zdarzenia.