Płatności cykliczne – punkt końcowy REST API

Płatności cykliczne rozszerza istniejące RESTful API wbudowane w Easy Digital Downloads. Dostęp do niego można uzyskać pod adresem

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN

Uwaga: upewnij się, że zastąpisz example.com własnym adresem oraz wartościami klucza i tokenu własnymi.

Powyższy przykład zwróci listę wszystkich istniejących subskrypcji w sklepie.

Wejście

Płatności cykliczne REST API akceptuje 3 opcje oprócz klucza i tokenu: customer, number i paged.

Klient

Wejściem dla klienta może być albo liczba całkowita reprezentująca customer_id, albo adres e-mail. Wynikowy adres URL będzie wyglądał podobnie do tego:

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&customer=2

lub

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&[email protected]

Liczba

Opcja number akceptuje liczbę całkowitą i zwraca tyle wyników. Przykład wyglądałby tak:

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=5

Stronicowanie

Opcja paged pozwala wybrać fragment większej liczby. Na przykład, jeśli masz 100 wpisów i użyjesz number=10, możesz podać paged=2, aby uzyskać wiersze 11-20. Wyglądałoby to tak:

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=10&paged=2

Wyjście

Wynik dla każdej subskrypcji zawiera wszystkie informacje o tej subskrypcji, a także o kliencie i każdej płatności odnowienia (dziecko). Dodatkowo istnieje wartość wskazująca czas poświęcony na uzyskanie informacji dla wszystkich wyników. Przykład:

{
    "subscriptions": [
        {
            "info": {
                "u0000EDD_Subscriptionu0000subs_db": {
                    "table_name": "wp_edd_subscriptions",
                    "version": "1.0",
                    "primary_key": "id"
                },
                "id": "1",
                "customer_id": "2",
                "period": "month",
                "initial_amount": "50.00",
                "recurring_amount": "50.00",
                "bill_times": "0",
                "parent_payment_id": "87",
                "product_id": "85",
                "created": "2016-03-15 15:36:30",
                "expiration": "2016-04-15 23:59:59",
                "status": "active",
                "profile_id": "paypal-363e3cc178dab152bb59b958024bce75",
                "gateway": "paypal",
                "customer": {
                    "id": "2",
                    "purchase_count": "2",
                    "purchase_value": "20.000000",
                    "email": "[email protected]",
                    "name": "Jane Doe",
                    "date_created": "2016-03-07 22:33:44",
                    "payment_ids": "16",
                    "user_id": "3",
                    "notes": [

                    ]
                }
            },
            "payments": [
                {
                    "id": 106,
                    "amount": 10.36,
                    "date": "March 21, 2016",
                    "status": "Renewal"
                },
                {
                    "id": 105,
                    "amount": 10,
                    "date": "March 21, 2016",
                    "status": "Renewal"
                },
                {
                    "id": 104,
                    "amount": 10,
                    "date": "March 21, 2016",
                    "status": "Renewal"
                }
            ]
        }
    ],
    "request_speed": 0.076335906982422
}