Dijeli putem


Istraživanje i testiranje Dataverse na igralištu web-API-ja (pretpregled)

[Ova tema spada u dokumentaciju predizdanja i podložna je promjenama.]

API igralište je unaprijed autentificirani alat za testiranje softvera koji pomaže proizvođačima da brzo i praktično komuniciraju s web API-jem Microsoft Dataverse .

Početni zaslon API igrališta

Ova web aplikacija omogućuje programerima testiranje i eksperimentiranje s različitim krajnjim točkama API-ja bez potrebe za opsežnim procesima postavljanja ili provjere autentičnosti. Također prikladno predstavlja određene dostupne radnje i poveznice na dokumentaciju za brže učenje.

Pomoću ovog alata istražite što je moguće u RESTful API-ju, testirajte korisnički definirane tijekove rada i još mnogo toga.

Važno

  • To je značajka pretpregleda.
  • Značajke pretpregleda nisu namijenjene u proizvodne svrhe i mogu imati ograničene funkcije. Te su značajke dostupne prije službenog izdavanja da bi se klijentima omogućio prijevremeni pristup i slanje povratnih informacija.

Glavne značajke

  • Prethodno autentificirano: API igralište dolazi unaprijed autentificirano, tako da razvojni inženjeri mogu odmah početi testirati i eksperimentirati s krajnjim točkama API-ja.
  • Temeljeno na webu: Uz API igralište, razvojni inženjeri mogu brzo komunicirati s web-API-jem Dataverse bez potrebe za opsežnim postavljanjem kao što su preuzimanja softvera ili postavljanje računa koji nije Microsoft. Alatu možete pristupiti iz ubrzivača Dataverse , Microsoftove aplikacije koja je dostupna u svim novim Dataverse okruženjima i može se instalirati u bilo kojem okruženju.
  • Praktično: Predstavlja različite radnje i mogućnosti dostupne u Web API-ju Dataverse , što olakšava brzo učenje što je moguće i kako to implementirati.

Preduvjeti

Morate imati pristup Dataverse i pristup za reprodukciju aplikacije Dataverse akceleratora. Članovi sigurnosne uloge osobe za prilagodbu sustava imaju pristup za reprodukciju aplikacije.

Započnite

Da biste započeli s igralištem API-ja, reproducirajte ubrzivač Dataverse ,a zatim odaberite stranicu igrališta API-ja.

Pokrenite API igralište odabirom kartice značajki

Upućivanje zahtjeva web-API-ju Dataverse

Na odredišnom zaslonu odaberite vrstu zahtjeva da biste otvorili uređivač zahtjeva tako da odaberete Stvori na bilo kojoj od najboljih kartica.

Prikazane su tri vrste zahtjeva:

Tip Opis
Prilagođeni API To uključuje sve Dataverse radnje web-API-ja, Microsoftove funkcije ili sve javne prilagođene API-je koje je definirao korisnik registrirane u radnom okruženju.
Trenutni dodatak Instant dodaci klasificirani su kao svi korisnički definirani tijekovi rada registrirani kao prilagođeni API u okruženju s povezanim FxExpressionom.
OData zahtjev Omogućuje detaljniju kontrolu nad unosima zahtjeva za slanje OData zahtjeva.

Zatražite prilagođeni API ili trenutni dodatak

Ove vrste zahtjeva osmišljene su za pojednostavljenje dodataka za pozivanje dostupnih u radnom okruženju.

  1. Odaberite opciju s glavnog padajućeg popisa koja prikazuje dostupne dodatke u trenutnom okruženju. Prilagođeni API-ji navedeni su na padajućem popisu

  2. Ako su parametri dostupni, prikazuju se u tablici parametara upita koja se pojavi. Navedite vrijednosti za potrebne parametre. Prilagođeni API parametri automatski se prikazuju

    Napomena

    Potvrdni okviri s lijeve strane svakog parametra označavaju jesu li uključeni u zahtjev. Obavezni parametri imaju onemogućene potvrdne okvire, dok neobavezni parametri imaju one koji se mogu uređivati.

  3. Odaberite Pošalji.

  4. Promatrajte odgovor u donjem dijelu zaslona. Parametri su navedeni ako su registrirani

Napomena

Sučelje omogućuje prikladan popis svih dostupnih dodataka u okruženju. Kada se odabere, prikazuju se parametri povezani s vrstama podataka. Iza kulisa se još uvijek upućuje OData poziv, ali sučelje pojednostavljuje konstrukciju poziva.

Napravite OData zahtjev

OData zahtjevi omogućuju više opcija za parametre zahtjeva.

  1. Odaberite metodu HTTP zahtjeva na prvom padajućem popisu.

  2. Upišite URL krajnje točke. URL zahtjeva uključite tek nakon [OrgUrl]/api/data/v9.2/

  3. Dodajte parametre upita pomoću jedne od dvije metode:

    1. U URL-u.

      1. Nakon znaka upitnika (?) u URL-u upišite ključ parametra upita. Ključ upisan u URL nakon upitnika

      2. Upišite znak jednakosti (=) iza tipke.

      3. Upišite vrijednost. Vrijednost upisana u URL nakon znaka jednakosti

      Ključevi i vrijednosti automatski će popuniti tablicu parametara u sučelju.

    2. Ručno dodajte parametre upita odabirom + Dodaj parametar. Time se u tablicu dodaje prazan redak parametara u koji možete upisivati vrijednosti. URL se dinamički ažurira prilikom unosa vrijednosti.

  4. Po želji navedite tijelo (ako koristite sve metode zahtjeva osim GET-a) odabirom kartice Tijelo , a zatim unesite vrijednost tijela u kontrolu uređivača.

  5. Odaberite Pošalji.

  6. Promatrajte odgovor u donjem dijelu.

Pogledajte odgovor

Nakon slanja zahtjeva, odgovor se prikazuje u donjoj polovici zaslona.

OData odgovor

Status odgovora pruža brze mjerne podatke o zahtjevu:

  • Poruka statusa
  • Trajanje (u milisekundama)
  • Veličina (u kilobajtima)

Tijelo odgovora prikazuje se ispod statusa odgovora. Odaberite ikonu kopiranja da biste kopirali tijelo odgovora u međuspremnik.

Česta pitanja o usluzi

Koje su privilegije potrebne za pristup alatu za igralište API-ja?

Da biste koristili alat, morate imati pristup aplikaciji Dataverse akceleratora.

Povezuje li se API alat za igrališta samo s web API-jem Dataverse ?

Da, API alat za igrališta povezuje se samo s web API-jem Dataverse . U ovom sučelju nisu dostupne druge usluge za povezivanje.

Kako se alat za igralište API-ja autentificira na web API-ju Dataverse ?

Alat koristi token za provjeru autentičnosti prijavljenog korisnika koji je potreban za reprodukciju aplikacije akceleratora Dataverse .

Je li značajka API playground dostupna u svim okruženjima?

Značajka se isporučuje putem akceleratora Dataverse i dostupna je u svim okruženjima u kojima je instalirana aplikacija. Aplikacija se automatski instalira u svim novim okruženjima, ali se može instalirati i u starijim okruženjima slijedeći upute za instalaciju.

Pogledajte

Rano dobivanje značajki pretpregleda pomoću ubrzivača Dataverse (pretpregled)