Roman Klimenko
EN

Brug af Postman til at interagere med CluedIn API

cluedinpostman

CluedIn tilbyder REST- og GraphQL-API'er. Du kan bruge dem til at indlæse data, eksportere data, migrere konfiguration og meget mere. Fordi web-UI'et selv er en klient til API'et, kan alt fra brugerfladen også automatiseres.

Du kan følge artiklen med ethvert programmeringssprog, kommandolinjeværktøjer som curl og wget eller apps som Insomnia og Nightingale. Jeg bruger Postman, et populært værktøj til at arbejde med API'er.

Lad os starte en CluedIn-instans, ĂĄbne Postman og gĂĄ i gang.

Opsætning af environment

Min CluedIn-instans er tilgængelig på https://foobar.172.167.52.102.sslip.io/.

CluedIn

I URL'en er subdomænet foobar organisationens navn. Du skal bruge det, fordi en CluedIn-instans kan have flere organisationer, hver med sine egne brugere, indstillinger og data.

172.167.52.102.sslip.io er det hoveddomæne, der tildeles, når CluedIn installeres fra Azure Marketplace. Du kan også konfigurere et custom domain som mdm.contoso.com.

I Postman kan du oprette din egen collection eller importere den collection, jeg bruger.

Opret derefter et environment til domænet og dine credentials. Med denne skabelon behøver du kun ændre nogle få værdier:

Postman Environment
  • domain: 172.167.52.102.sslip.io i mit tilfælde.
  • org_name: organisationens navn, som er foobar i mit tilfælde.
  • protocol: brug https, medmindre du kører CluedIn lokalt i Docker.
  • user_email og password: credentials til din brugerkonto. Nogle API'er kræver brugerens access token, mens andre accepterer et API-token oprettet i web-UI'et. Du kan udelade disse credentials, hvis du bruger et API-token.

Environmentet indeholder ogsĂĄ nogle foruddefinerede URL'er:

  • org_url: {{protocol}}://{{org_name}}.{{domain}} bliver til https://foobar.172.167.52.102.sslip.io. De andre CluedIn API-URL'er bygger pĂĄ denne værdi.
  • auth_url: {{org_url}}/auth bliver til https://foobar.172.167.52.102.sslip.io/auth. Brug den til at logge ind med e-mail og adgangskode, oprette brugere og udføre andre authentication-opgaver.
  • api_url: {{org_url}}/api/api bliver til https://foobar.172.167.52.102.sslip.io/api/api. De fleste API'er ligger under denne URL.
  • graphql_api_url: {{api_url}}/graphql bliver til https://foobar.172.167.52.102.sslip.io/api/api/graphql. Dette GraphQL-endpoint bruges til at eksportere data og accepterer et API-token oprettet i CluedIn.
  • graphql_url: {{org_url}}/graphql bliver til https://foobar.172.167.52.102.sslip.io/graphql. Web-UI'et bruger dette GraphQL-endpoint til sine egne operationer. Det kræver brugerens access token og accepterer ikke API-tokens.

Hent et token

Brug nu Postman til at kalde login-API'et og hente brugerens access token.

Kald endpointet "Get a Token":

Get a Token

Efter en vellykket request tilføjer collectionen automatisk nogle variabler til environmentet:

Postman Environment
  • access_token: den JWT, der bruges til at tilgĂĄ CluedIn API'et.
  • refresh_token: tokenet, der bruges til at forny access tokenet.
  • org_id: organisationens id, som nogle kald kræver. NĂĄr det gemmes her, behøver du ikke hente det separat.

Kald CluedIn API'er

Nu kan du kalde CluedIn API'er. Prøv for eksempel at kalde "Get Schema" for at få den fulde liste over CluedIn Vocabulary keys og deres mappings:

Get CluedIn Vocabulary Keys

Til sidst

Nogle nyttige pĂĄmindelser: