Neste artigo, você vai aprender a criar novos artigos e atualizar artigos existentes na Central de Ajuda do Cloud Chat via API REST.

Para criar um novo artigo na central de ajuda do Cloud Chat, basta realizar uma requisição POST para:

https://{{{CLOUDCHAT_DOMAIN}}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles

Requisição com campos de exemplo:

curl --location 'https://{{{CLOUDCHAT_DOMAIN}}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles' \
--header 'Content-Type: application/json' \
--header 'api_access_token: YOUR_TOKEN_HERE' \
--data '{
    "content": "Conteúdo do artigo...",
    "status": 0, //Deve iniciar como draft!
    "title": "Título do artigo",
    "author_id": 1,
    "category_id": 1
}'

Para marcar o artigo como "publicado" é necessário fazer uma segunda request, dessa vez um PUT, alterando o status para 1:

curl --location --request PUT 'https://{{{CLOUDCHAT_DOMAIN}}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles/{{ARTICLE_ID}}' \
--header 'Content-Type: application/json' \
--header 'api_access_token: YOUR_TOKEN_HERE' \
--data '{
    "status": 1,
    // --- Demais campos abaixo são opcionais ---
    //"title": "...",
    //"content": "...",
    //"author_id": 2,
    //"category_id": 20,
}'

Para remover um artigo, basta passar o método como DELETE e um body vazio:

curl --location --request DELETE 'https://{{{CLOUDCHAT_DOMAIN}}}/api/v1/accounts/{{ACCOUNT_ID}}/portals/{{PORTAL_SLUG}}/articles/{{ARTICLE_ID}}' \
--header 'Content-Type: application/json' \
--header 'api_access_token: YOUR_TOKEN_HERE' \
--data '{
    "name": "Help name",
    "config": { "allowed_locales": ["en", "es"] }
}'

Parâmetros necessários

CLOUDCHAT_DOMAIN: Você pode obter seu domínio ao fazer login na sua conta no Cloud Chat. É a parte que aparece na URL do navegador:

ACCOUNT_ID: Obtido na seção de configurações da conta:

API_TOKEN: Obtido nas configurações do seu perfil de usuário no Cloud Chat (https://{{{CLOUDCHAT_DOMAIN}}}/app/accounts/{{{ACCOUNT_ID}}}/profile/settings)

author_id e category_id podem ser encontrados ao inspecionar a requisição que é realizada no navegador durante alguma alteração na própria tela de artigos:

Nota sobre PORTAL_SLUG

O parâmetro PORTAL_SLUG na URL é o slug do portal (ex: meu-portal), não um ID numérico. Você encontra o slug na URL do portal na interface do Cloud Chat.