EDD REST API – Punkty końcowe

EDD REST API zawiera sześć punktów końcowych do uzyskiwania informacji, każdy do wykonywania określonego rodzaju żądania:

• stats – Do pobierania statystyk zarobków/sprzedaży dla określonych dat, zakresów dat i konkretnych produktów.
• products – Do pobierania informacji o produktach sklepu.
• customers – Do pobierania statystyk klientów.
• sales – Do pobierania ostatnich sprzedaży i informacji o każdej sprzedaży (zakupione przedmioty, kupujący, kwota itp.).
• discounts – Do pobierania informacji o wszystkich dostępnych zniżkach.
• download-logs – Do pobierania logów pobierania plików.

Punkty końcowe są używane w następujący sposób:

https://example.com/edd-api//

Na przykład:

https://example.com/edd-api/sales/

W połączeniu z kluczem API i tokenem, kompletny adres URL wygląda tak:

https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70

Widoczność

Wszystkie punkty końcowe wymagają klucza API i tokena, z wyjątkiem punktu końcowego produktów. Dzieje się tak, ponieważ produkty domyślnie mają być zawsze publiczne.

Format odpowiedzi

Odpowiedź zwracana przez EDD API jest dostępna w dwóch formatach:

• JSON (domyślnie)
• XML

Aby określić zwracany format (jeśli żaden nie zostanie określony, użyty zostanie JSON), po prostu dodaj argument
format do adresu URL:

https://yoursite.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&format=xml

Przykładowa odpowiedź JSON wygląda tak:

{
    "sales": [
        {
            "ID": 611,
            "subtotal": "20",
            "tax": 0,
            "fees": false,
            "total": "20",
            "gateway": "manual",
            "email": "[email protected]",
            "date": "2013-02-25 11:42:05",
            "products": [
                {
                    "name": "Simple Notices Pro",
                    "price": "20",
                    "price_name": "Price one"
                }
            ]
        }
    ]
}

Przykładowa odpowiedź XML (dla tego samego zapytania) wygląda tak:

  
    611
    20
    0
    false
    20
    manual
    [email protected]
    2013-02-25 11:42:05
    
      Simple Notices Pro
      20
      Price one
    
  

Opcjonalne zmienne URL

Możesz dodać dodatkowe zmienne URL, aby dostosować zwracane dane. Oto kilka przykładów, jak możesz to zrobić.

• Liczba: Domyślnie API wyświetla 10 wyników na stronę, jeśli tak zostało ustawione w Twoich ustawieniach czytania w WordPress. Ale jeśli chcesz to zmienić dla konkretnego wywołania API, możesz dodać „&number=11” do adresu URL, aby uzyskać inną liczbę wyników na stronę. W tym przykładzie otrzymasz 11 wyników.
• Strona: Domyślnie API wyświetla stronę numer 1 wyników. Jeśli chcesz to zmienić dla konkretnego wywołania API, możesz dodać „&page=2” do adresu URL, aby uzyskać inną stronę wyników.