How to get a category name with the ID via API

Dev
1

I use Discourse API client for PHP (by @michaeld I guess) and I can’t find how to get a category name/slug with only with an ID.

I need it to display (slug and id) of all our categories and their sub-categories.
But when I get the categories list, the only information about sub-categories is their id.

2

I asked the same question a long time ago,
https://meta.discourse.org/t/how-to-get-subcategory-names-using-api/29795

3

Thanks, is it implemented in your php client ?

4

No, we never implemented that. Should be fairly easy to do, I can take a look later today.

5 
function getCategoryById($categoryId) {
       $datas = $this->_getRequest("/site.json");
       $categories = $datas->apiresult->categories;
       foreach($categories as $categorie) {
         if(($categorie->id) == $categoryId) {
           return $categorie;
         }
       }
6

You should probably save the data in a global, so you can call the function multiple times in the same PHP script.

7

I’d rather use /site.json once (to limit the API’s calls). We’ve added the following function to DiscourseApi.php :

function getSite()
    {
        return $this->_getRequest("/site.json");
    }

and then use it to get wanted informations :

  $categories = $discourseApi->getSite()->apiresult->categories;
  foreach ($categories as $category) {
    if (isset($category->parent_category_id)){
      $categories_all[$category->parent_category_id]['subcategory'][$category->id]['id'] = $category->id;
      $categories_all[$category->parent_category_id]['subcategory'][$category->id]['slug'] = $category->slug;
      $categories_all[$category->parent_category_id]['subcategory'][$category->id]['name'] = $category->name;
    } else {
      $categories_all[$category->id]['id'] = $category->id;
      $categories_all[$category->id]['slug'] = $category->slug;
      $categories_all[$category->id]['name'] = $category->name;
    }
  }

(code from congressus/application/config/discourse.structure.php at master · PartiPirate/congressus · GitHub)

(We don’t use the getCategoryById() I’ve suggested before)

8

site.json parece ser a maneira de obter uma lista de todas as categorias. Isso é mencionado em algum lugar no docs.discourse.org? Eu estava vasculhando a documentação procurando uma maneira de obter os nomes das subcategorias e não consegui encontrar. Ou há uma maneira melhor?

9

Fazer uma requisição de API para site.json é a maneira correta de obter uma lista de categorias que inclui subcategorias. Além disso, se você quiser que categorias privadas sejam retornadas pela requisição a site.json, é necessário fazer uma requisição de API autenticada.

Não estou vendo nenhuma referência a site.json na documentação. Como categories.json não retorna subcategorias, a descrição da rota categories na documentação não está correta; ela afirma que a rota retorna todas as categorias. Vou corrigir isso.