La API REST de EDD incluye seis puntos finales para acceder a la información, cada uno para realizar un tipo específico de solicitud:
- stats – Para recuperar estadísticas de ganancias/ventas de fechas específicas, rangos de fechas y productos específicos.
- products – Para recuperar información sobre los productos de la tienda.
- customers – Para recuperar estadísticas de clientes.
- sales – Para recuperar ventas recientes e información sobre cada venta (artículos comprados, comprador, monto, etc.).
- discounts – Para recuperar información sobre todos los descuentos disponibles.
- download-logs – Para recuperar registros de descargas de archivos.
Los puntos finales se usan de la siguiente manera:
https://example.com/edd-api//
Por ejemplo:
https://example.com/edd-api/sales/
Cuando se combina con la clave API y el token, la URL completa se ve así:
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Visibilidad
Todos los puntos finales requieren la clave API y el token, excepto el punto final de productos. Esto se debe a que los productos están destinados a ser públicos en todo momento por defecto.
Formato de respuesta
La respuesta proporcionada por la API de EDD está disponible en dos formatos:
Para especificar el formato devuelto (se usará JSON si no se especifica ninguno), simplemente agregue el argumento
format a la URL:
https://yoursite.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&format=xml
Una respuesta JSON de ejemplo se ve así:
{
"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"
}
]
}
]
}
Una respuesta XML de ejemplo (para la misma consulta) se ve así:
611
20
0
false
20
manual
[email protected]
2013-02-25 11:42:05
Simple Notices Pro
20
Price one
Variables de URL opcionales
Puede agregar variables de URL adicionales para ajustar la salida que se proporciona. Aquí hay algunos ejemplos de cómo puede hacerlo.
- Número: Por defecto, la API mostrará 10 resultados por página, si eso es lo que ha configurado en sus ajustes de Lectura en WordPress. Pero si desea cambiar eso para una llamada API específica, puede agregar “&number=11” a la URL para obtener un número diferente de resultados por página. En este ejemplo, obtendría 11 resultados.
- Página: Por defecto, la API mostrará la página número 1 de los resultados. Si desea cambiar eso para una llamada API específica, puede agregar “&page=2” a la URL para obtener una página diferente de resultados.
