API REST do EDD – Endpoints

A API REST do EDD inclui seis endpoints para acessar informações, cada um para realizar um tipo específico de solicitação:

• stats – Para recuperar estatísticas de ganhos/vendas de datas específicas, intervalos de datas e produtos específicos.
• products – Para recuperar informações sobre os produtos da loja.
• customers – Para recuperar estatísticas de clientes.
• sales – Para recuperar vendas recentes e informações sobre cada venda (itens comprados, comprador, valor, etc.).
• discounts – Para recuperar informações sobre todos os descontos disponíveis.
• download-logs – Para recuperar logs de downloads de arquivos.

Os endpoints são usados da seguinte forma:

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

Por exemplo:

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

Quando combinada com a chave de API e o token, a URL completa fica assim:

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

Visibilidade

Todos os endpoints exigem a chave de API e o token, exceto o endpoint de produtos. Isso ocorre porque os produtos são destinados a serem públicos por padrão o tempo todo.

Formato da Resposta

A resposta fornecida pela API do EDD está disponível em dois formatos:

• JSON (padrão)
• XML

Para especificar o formato retornado (o JSON será usado se nenhum for especificado), basta adicionar o argumento
format à URL:

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

Uma amostra de resposta JSON se parece com isto:

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

Uma amostra de resposta XML (para a mesma consulta) se parece com isto:

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

Variáveis de URL Opcionais

Você pode adicionar variáveis de URL adicionais para ajustar a saída fornecida. Aqui estão alguns exemplos de como você pode fazer isso.

• Número: Por padrão, a API exibirá 10 resultados por página, se for o que você definiu em suas configurações de Leitura no WordPress. Mas se você quiser mudar isso para uma chamada de API específica, você pode adicionar “&number=11” à URL para obter um número diferente de resultados por página. Neste exemplo, você obteria 11 resultados.
• Página: Por padrão, a API exibirá a página número 1 dos resultados. Se você quiser mudar isso para uma chamada de API específica, você pode adicionar “&page=2” à URL para obter uma página diferente de resultados.