VPD Playground to graficzny interfejs webowy, który umożliwia pisanie i wykonywanie zapytań GraphQL w usłudze VPD, bez konieczności pisania kodu lub uruchamiania klienta HTTP. Idealny do eksploracji schematu, testowania zapytań i szybkiego przeglądania wyników.

Playground jest dostępny na stronie VPD:

Do korzystania z Playground potrzebne są ważne dane uwierzytelniające OAuth2. Należy zalogować się danymi klienta (scope vpd), aby rozpocząć sesję.

Playground oferuje edytor z podświetlaniem składni i autouzupełnianiem dla GraphQL. Zapytanie wpisuje się w lewym panelu, a wynik widoczny jest bezpośrednio w prawym panelu. Główne możliwości:

• Eksploracja schematu: wbudowany documentation explorer pokazuje wszystkie dostępne pola, typy i parametry wyszukiwania
• Pisanie i wykonywanie zapytań: wpisanie zapytania, naciśnięcie przycisku play i przeglądanie wyniku jako JSON
• Używanie zmiennych: definiowanie zmiennych w panelu zmiennych, aby zapytania były wielokrotnego użytku
• Inspekcja wyników: wynik JSON jest bezpośrednio czytelny w interfejsie

Należy otworzyć Playground, uwierzytelnić się danymi i wykonać na przykład to zapytanie:

{
  parties(name: "eConnect", country: "NL", maxResults: 3) {
    legalName
    partyIds {
      type
      value
    }
    locations {
      city
    }
  }
}

Odpowiedź pojawia się bezpośrednio w prawym panelu. Widoczna będzie nazwa prawna, identyfikatory i miasto siedziby znalezionych organizacji.

Po prawej stronie Playground znajduje się documentation explorer. Kliknięcie na typ lub pole pokazuje dostępne podpola. To najszybszy sposób na odkrycie, jakie dane są dostępne, bez oddzielnego korzystania z dokumentacji API.

Explorer pokazuje pełny schemat party, łącznie z typami pól, opisami i informacją, czy pole jest opcjonalne. Należy go używać jako materiału referencyjnego przy budowaniu zapytań.

Zaleca się testowanie zawsze najpierw w środowisku akceptacyjnym (accp-vpd.econnect.eu) przed wykonywaniem zapytań na produkcji. Należy używać parametru maxResults do ograniczania liczby wyników podczas testów. Warto też korzystać z autouzupełniania w edytorze: oszczędza czas i zapobiega błędom w nazwach pól.

Chcą Państwo strukturalnie zintegrować VPD w swojej aplikacji? Artykuł o tym, jak wykorzystać VPD w integracji.

• Przegląd VPD
• Schemat VPD: pola i zapytania
• Używanie VPD w integracji
• Rejestracja na Peppol
• E-fakturowanie z eConnect