EDD REST API – Eindpunten

De EDD REST API bevat zes eindpunten voor toegang tot informatie, elk voor het uitvoeren van een specifiek soort verzoek:

• stats – Voor het ophalen van verdiensten/verkoopstatistieken voor specifieke datums, datumbereiken en specifieke producten.
• products – Voor het ophalen van informatie over winkelproducten.
• customers – Voor het ophalen van klantstatistieken.
• sales – Voor het ophalen van recente verkopen en informatie over elke verkoop (gekochte items, koper, bedrag, etc.).
• discounts – Voor het ophalen van informatie over alle beschikbare kortingen.
• download-logs – Voor het ophalen van logs van bestand downloads.

De eindpunten worden als volgt gebruikt:

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

Bijvoorbeeld:

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

In combinatie met de API-sleutel en token ziet de volledige URL er als volgt uit:

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

Zichtbaarheid

Alle eindpunten vereisen de API-sleutel en token, behalve het products-eindpunt. Dit komt omdat producten standaard altijd openbaar bedoeld zijn.

Responsformaat

Het antwoord van de EDD API is beschikbaar in twee formaten:

• JSON (standaard)
• XML

Om het geretourneerde formaat te specificeren (jSON wordt gebruikt als er geen is opgegeven), voegt u eenvoudig het
format argument toe aan de URL:

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

Een voorbeeld van een JSON-respons ziet er als volgt uit:

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

Een voorbeeld van een XML-respons (voor dezelfde query) ziet er als volgt uit:

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

Optionele URL-variabelen

U kunt aanvullende URL-variabelen toevoegen om de gegeven uitvoer aan te passen. Hier zijn enkele voorbeelden van hoe u dat kunt doen.

• Aantal: Standaard toont de API 10 resultaten per pagina, als dat is ingesteld onder uw Leesinstellingen in WordPress. Maar als u dat wilt wijzigen voor een specifieke API-oproep, kunt u “&number=11” toevoegen aan de URL om een ander aantal resultaten per pagina te krijgen. In dit voorbeeld krijgt u 11 resultaten.
• Pagina: Standaard toont de API paginanummer 1 van de resultaten. Als u dat wilt wijzigen voor een specifieke API-oproep, kunt u “&page=2” toevoegen aan de URL om een andere pagina met resultaten te krijgen.