Aller au contenu

Lista o catálogo de módulos de space por categoria

GET/api/spaces/modules

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
moderator
Clé d’API:
community:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Catálogo estático dos módulos de space, agrupados nas categorias `community`, `people` e `coworking`, nessa ordem — que é a ordem das abas do seletor de módulo na criação de space. Dentro de cada categoria, os módulos vêm na ordem de exibição.

Cada módulo traz a `key` estável, `available` e `layouts`. O rótulo é traduzido pelo app; a API não devolve texto para o usuário.

`layouts` é `{ options, default }` nos módulos em que a equipe escolhe a exibição dos itens (Conteúdo, Eventos, Cursos, Downloads, Classificados e Galeria) e `null` nos outros. `default` é a exibição de hoje do módulo, a que vale enquanto o space tem `layout: null`. São os únicos valores aceitos em `layout` no `POST` e no `PUT`.

`available: false` marca um módulo **planejado**: ele aparece no catálogo para o app mostrar como "em breve", mas **não** é aceito em `POST /api/spaces` nem em `PUT /api/spaces/{id}`. Os módulos com `available: true` são exatamente os aceitos no campo `module`.

`locked: true` (na categoria e em cada módulo dela) marca uma categoria de extensão (`people` = Planejamento & RH, `coworking`) que o plano da comunidade não libera (`modules.people`, `modules.coworking`). O seletor mostra o cadeado "contrate a extensão"; criar ou editar um space desses módulos responde 403. Os spaces que já existem continuam de pé, visíveis só a owner, admin e moderador.

Restrito a owner e admin da comunidade do `X-CommunityId` — o mesmo papel que pode criar space.

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

StatutDescription
200Catálogo de módulos agrupado por categoria.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/spaces/modules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"