PHP - Exemplo de API Data Explorer

Dados e relatórios
1

Estou trabalhando para extrair dados do Discourse usando PHP e a API do Data Explorer. Aqui está o esqueleto do meu código PHP para que outros possam usá-lo como ponto de partida.

Código PHP

<?php
// Define a chave da API
$api_key = '<sua chave vai aqui>';
//
// 1. $url deve ser definida para a URL do seu fórum Discourse
// 2. Obtenha o número da consulta que você deseja executar. Atualize a URL para essa consulta
//    ou seja, consulta nº 5 => .../queries/5/run
//    ou seja, consulta nº 47 => .../queries/47/run
$url = 'https://discourse.com/admin/plugins/explorer/queries/7/run';
//
// Atualize seus parâmetros para passar para a consulta.
// Exemplo para um parâmetro - codificado
// $data = 'params={"user":"fred_smith"}';   
// Exemplo para um parâmetro - passando uma variável
// $data = 'params={"user":"'.$user.'"}';   
// Exemplo para dois ou mais parâmetros - passando uma variável
$data = 'params={"user":"'.$user.'","term":"'.$term.'"}';   
//
// Comandos Curl
//
$headers = array("Content-Type: multipart/form-data;", "Api-Key: $api_key", "Api-Username: system",);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers );
curl_setopt($ch, CURLOPT_POSTFIELDS,$data);

$result = curl_exec( $ch );
if ( curl_errno( $ch ) !== 0 ) {
   // Lidar com o erro, chamar curl_close( $ch ) e retornar.
}
curl_close( $ch );
//
// Converta o resultado do curl em um array php para trabalhar programaticamente
$result_array = json_decode( $result,true);

print($result_array);

?>

Consulta do Data Explorer

No exemplo do código usando duas variáveis passadas, meu código do data explorer ficou assim:

--[params]
-- string :term
-- string :user

SELECT users.username, posts.id, uploads.url, topics.title
     FROM upload_references
     JOIN uploads ON uploads.id = upload_references.upload_id
     JOIN posts   ON posts.id   = upload_references.target_id
     JOIN topics  ON topics.id  = posts.topic_id
     JOIN users   ON posts.user_id = users.id
    WHERE (posts.cooked like '%' || :term || '%' 
       OR topics.title like '%' || :term || '%') 
      AND users.username_lower like '%' || :user || '%'
      AND topics.archetype = 'regular'
 ORDER BY uploads.created_at DESC
 limit 10

Espero que isso ajude alguém a dar o pontapé inicial em um projeto.

3 curtidas
2

Eu removeria a maioria dos comentários para facilitar a leitura :slight_smile:
Alguns comentários são desnecessários, como:

// Obter resultado
//
$result = curl_exec( $ch );

ou

// fechar sessão curl
curl_close( $ch );

Além disso, saiba que você pode definir o realce de sintaxe anexando o nome do idioma à primeira linha das crases:

```php
$headers = array("Content-Type: multipart/form-data;","Api-Key: $api_key","Api-Username: system",);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers );
curl_setopt($ch, CURLOPT_POSTFIELDS,$data);
```

Renderiza como

$headers = array("Content-Type: multipart/form-data;","Api-Key: $api_key","Api-Username: system",);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers );
curl_setopt($ch, CURLOPT_POSTFIELDS,$data);
3

Obrigado pelo feedback. Atualizei as postagens iniciais.