Plăți Recurente – Punct final API REST

Plăți Recurente extinde API-ul RESTful existent integrat în Easy Digital Downloads. Poate fi accesat la

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

Notă: asigurați-vă că înlocuiți example.com cu propriul dvs. adresă și valorile cheie și token cu ale dvs.

Exemplul de mai sus va returna o listă a tuturor abonamentelor existente în magazin.

Intrare

API-ul REST pentru Plăți Recurente acceptă 3 opțiuni pe lângă cheie și token: customer, number și paged.

Client

Intrarea pentru un client poate fi fie un număr întreg reprezentând un customer_id, fie o adresă de e-mail. URL-ul rezultat va arăta similar cu acesta:

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

sau

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

Număr

Opțiunea number acceptă un număr întreg și returnează atâtea rezultate. Un exemplu ar arăta astfel:

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

Paginat

Opțiunea paged vă permite să alegeți o porțiune dintr-un număr mai mare. De exemplu, dacă aveți 100 de intrări și folosiți number=10, ați putea trece paged=2 și ați putea obține rândurile 11-20. Acest lucru ar arăta astfel:

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

Ieșire

Ieșirea pentru fiecare abonament conține toate informațiile despre acel abonament, precum și despre client și fiecare plată de reînnoire (copil). În plus, există o valoare care indică timpul petrecut pentru obținerea informațiilor pentru toate rezultatele. Exemplu:

{
    "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
}