Utforska och testa Dataverse i testplatsen för webb-API:et (förhandsversion)

[Det här avsnittet utgör förhandsdokumentation och kan komma att ändras.]

Important

Funktionerna för Dataverse-accelerator, plugin-övervakning och API Playground är inte prioriterade och kommer inte att levereras som separata funktioner. Information om tillgänglighet för förhandsversionsfunktioner finns i Förhandsversionsprogrammet för Power Apps.

API Playground är ett förautentiserat verktyg för programvarutestning som hjälper tillverkare att snabbt och bekvämt interagera med Microsoft Dataverse webb-API.

Startskärm för API-lekplats

Med det här webbprogrammet kan utvecklare testa och experimentera med olika API-slutpunkter utan att det krävs omfattande konfigurations- eller autentiseringsprocesser. Dessutom presenteras vissa tillgängliga åtgärder och länkar till dokumentation för snabbare utbildning.

Använd det här verktyget för att utforska vad som är möjligt i RESTful API, testa användardefinierade arbetsflöden och mer.

Important

  • Detta är en förhandsgranskningsfunktion.
  • Förhandsversionsfunktioner ska inte användas i produktion och funktionerna kan vara begränsade. Dessa funktioner är tillgängliga före en officiell release så att kunderna kan få tidig tillgång och ge feedback.

Viktiga funktioner

  • Förautentiserad: API-testplats är förautentiserad, så utvecklare kan börja testa och experimentera med API-slutpunkter direkt.
  • Webbaserat: Med API-lekplatsen kan utvecklare snabbt interagera med Dataverse webb-API utan behov av omfattande inställningar som nedladdningar av programvara eller konfigurering av konton som inte är från Microsoft. Du får åtkomst till verktyget från Dataverse accelerator, en Microsoft-app som är tillgänglig i alla nya Dataverse-miljöer och kan installeras i alla miljöer.
  • Bekvämt: Presenterar de olika åtgärderna och funktionerna som finns tillgängliga i Dataverse webb-API, vilket gör det enkelt att snabbt lära sig vad som är möjligt och hur man implementerar det.

Förutsättningar

Du måste ha åtkomst till Dataverse och tillgång till appen Dataverse accelerator. Medlemmar med säkerhetsrollen Systemanpassare har åtkomst till att använda appen.

Kom igång

Kom igång med API-testplats, spela upp Dataverse accelerator och välj sedan sidan API-testplats.

Kör API-testplats genom att välja funktionskort

Skicka begäran till Dataverse webb-API

På landningsskärmen väljer du begäranstyp för att öppna begäransredigeraren genom att välja Skapa på något av de översta korten.

Tre typer av begäran presenteras:

Type Description
Anpassat API Detta omfattar Dataverse webb-API åtgärder, funktioner från Microsoft samt publika användardefinierade anpassade API:er som är registrerade i arbetsmiljön.
Omedelbar insticksmodul Direkta plugin-program klassificeras som alla användardefinierade arbetsflöden registrerade som ett anpassat API i miljön med en relaterad FxExpression.
OData-begäran Tillåter mer detaljerad kontroll över begärans indata för att skicka OData-begäran.

Begär ett anpassat API eller ett direkt insticksprogram

Dessa begäranstyper har utformats för att förenkla anrop av insticksprogram som är tillgängliga i arbetsmiljön.

  1. Välj ett alternativ i den huvudsakliga listrutan som visar tillgängliga plugin-program i den aktuella miljön. Anpassade API:er visas i listrutan

  2. Om det finns tillgängliga parametrar visas de i tabellen Frågeparametrar. Ange värden för nödvändiga parametrar. Anpassade API-parametrar visas automatiskt

    Anmärkning

    Kryssrutor till vänster om varje parameter anger om de ingår i begäran. Obligatoriska parametrar har inaktiverade kryssrutor medan valfria parametrar har redigerbara parametrar.

  3. Välj Skicka.

  4. Observera svaret i den nedre delen av skärmen. Parametrar visas om de är registrerade

Anmärkning

Gränssnittet gör det praktiskt att lista alla tillgängliga plugin-program i miljön. När alternativet är valt visas de associerade parametrarna med datatyper. Bakom kulisserna pågår fortfarande ett OData-anrop, men gränssnittet förenklar uppbyggnaden av anropet.

Göra en OData-begäran

OData-begäran tillåter fler alternativ för begäransparametrar.

  1. Välj HTTP-begäransmetod i den första listrutan.

  2. Skriv in slutpunkt-URL. Ta endast med begäran-URL efter [OrgUrl]/api/data/v9.2/

  3. Lägg till frågeparametrar med en av de två metoderna:

    1. I URL:en.

      1. Efter frågetecknet (?) i URL:en skriver du frågeparameternyckeln. Nyckel inmatad i webbadress efter frågetecken

      2. Skriv ett lika med (=) tecken efter nyckeln.

      3. Skriv in värdet. Värde som skrivits in i URL efter likhetstecknet

      Nycklarna och värdena fylls i automatiskt i parametertabellen i gränssnittet.

    2. Lägg till frågeparametrar manuellt genom att välja + Lägg till param. Då läggs en tom parameterrad till i tabellen som du kan skriva värden i. URL:en uppdateras dynamiskt när värden anges.

  4. Infoga alternativt en brödtext (om du använder alla begäransmetoder utom GET) genom att välja fliken Brödtext och sedan ange brödtextvärdet i redigeringskontrollen.

  5. Välj Skicka.

  6. Observera svaret i den nedre delen.

Visa svaret

När en begäran har skickats visas svaret i den nedre delen av skärmen.

OData-svar

Svarsstatus ger snabba mått på begäran:

  • Statusmeddelande
  • Varaktighet (i millisekunder)
  • Storlek (i kilobyte)

Brödtexten för svaret visas under svarsstatusen. Välj kopieringsikonen för att kopiera svaret till urklipp.

Vanliga frågor

Vilka privilegier krävs för att få åtkomst till verktyget för API-testplats?

Du måste ha åtkomst till appen Dataverse accelerator för att använda verktyget.

Ansluter API-lekplatsverktyget endast till Dataverse Web API?

Ja, verktyget API-testplats ansluter bara till Dataverse webb-API. Det finns inga andra tjänster att ansluta till i det här gränssnittet.

Hur autentiserar API-verktyget till Dataverse webb-API?

Verktyget använder autentiseringstoken för den inloggade användare som krävs för att kunna använda appen Dataverse accelerator.

Är funktionen API-testplats tillgänglig i alla miljöer?

Funktionen levereras via Dataverse-acceleratorn och är tillgänglig i alla miljöer där programmet finns installerat. Programmet installeras automatiskt i alla nya miljöer men kan även installeras i äldre miljöer genom att följa installationsanvisningarna.

Se även

Få förhandsgranskningsfunktioner tidigt med hjälp av Dataverse-acceleratorn (förhandsvisning)

  • Last updated on