Guia básico para integração com a API

Atualizado há 3 semanas

A API do Metricool conecta as tuas próprias ferramentas e scripts ao Metricool para que possas exportar dados e criar, agendar e gerir publicações fora da aplicação. Este guia acompanha-te desde a obtenção do acesso até à tua primeira chamada à API.

Antes de começar

A API está disponível nos planos Advanced e Custom. Os planos Free e Starter não incluem acesso à API.

Acede a Definições da conta > API.
Copia o teu token de acesso à API.
Abre a documentação oficial da API através do ícone de informação ℹ️ junto ao campo do token ou diretamente em https://app.metricool.com/resources/apidocs/index.html. Também está disponível um guia em PDF para download: API English PDF.

Autentica todas as chamadas

Todos os endpoints requerem autenticação com três valores: o teu token no cabeçalho X-Mc-Auth, além de userId e blogId como parâmetros da solicitação. As solicitações com corpo também usam Content-Type: application/json.

X-Mc-Auth: YOUR_API_TOKEN
Content-Type: application/json

userId identifica a tua conta do Metricool e blogId identifica a marca. Podes consultar ambos no URL do navegador quando abres uma marca na aplicação:

https://app.metricool.com/evolution/web?blogId=00000&userId=0000000

Para listar todas as marcas que geres ou que foram partilhadas contigo, chama https://app.metricool.com/api/admin/simpleProfiles?userId=YOUR_USER_ID. Cada entrada inclui o respetivo blogId. Para um guia específico sobre o ID da conta, consulta Como encontrar o teu ID de utilizador do Metricool.

Cria e agenda uma publicação

Envia uma solicitação POST para o endpoint do agendador com a data de publicação, o texto da publicação e, pelo menos, uma rede:

POST https://app.metricool.com/api/v2/scheduler/posts?blogId={blogId}&userId={userId}

O corpo da solicitação requer:

publicationDate: a data deve ser futura e estar no formato ISO 8601 com um fuso horário, por exemplo Europe/Madrid.
text: o conteúdo da publicação.
providers: pelo menos uma rede, por exemplo { "network": "facebook" }.

Exemplo de corpo da solicitação:

{
  "publicationDate": {
    "dateTime": "2025-07-23T10:00:00",
    "timezone": "Europe/Madrid"
  },
  "text": "Hello! This is a scheduled post test.",
  "providers": [
    { "network": "facebook" }
  ]
}

As definições opcionais incluem draft (define como true para guardar a publicação como rascunho em vez de a agendar), autoPublish, firstCommentText e blocos específicos de cada rede, como facebookData, instagramData, twitterData, linkedinData, pinterestData, youtubeData, tiktokData, gmbData, threadsData e blueskyData, para opções por rede, como o tipo de publicação do Facebook ou a publicação automática do Instagram. A referência completa dos parâmetros está nos ficheiros Swagger .yaml e .json ligados na documentação da API.

O que podes fazer com publicações agendadas

Os endpoints do agendador permitem realizar estas ações. Todos os caminhos são relativos ao URL base https://app.metricool.com/api.

Ação	Método e caminho
Criar uma publicação agendada	`POST /v2/scheduler/posts`
Listar publicações agendadas entre duas datas	`GET /v2/scheduler/posts`
Obter uma publicação agendada por ID	`GET /v2/scheduler/posts/{id}`
Atualizar uma publicação agendada	`PUT /v2/scheduler/posts/{id}`
Editar e atualizar campos selecionados	`PATCH /v2/scheduler/posts/{id}`
Eliminar uma publicação agendada	`DELETE /v2/scheduler/posts/{id}`
Enviar várias publicações de uma marca para revisão em massa	`PUT /v2/scheduler/posts`
Aprovar ou rejeitar uma publicação agendada	`PUT /v2/scheduler/posts/{id}/approvals`
Obter a configuração da marca para enviar uma publicação para revisão	`GET /v2/scheduler/posts/approvals-config`
Obter as propriedades das publicações do Instagram de uma marca	`GET /v2/scheduler/posts/instagram-properties`

Adicionar multimédia a uma publicação agendada

Os links de multimédia devem ser públicos e não podem expirar: os URLs privados ou temporários são ignorados e a publicação é agendada sem multimédia. Para anexar multimédia, prepara-a antes de chamares o endpoint do agendador:

Normaliza o URL da multimédia com uma solicitação GET para que o ficheiro seja alojado nos servidores do Metricool quando necessário:
https://app.metricool.com/api/actions/normalize/image/url?url=<URL_OF_YOUR_MEDIA>
Faz referência à multimédia na tua publicação através do respetivo mediaId:
"media": { "mediaId": "ID_OF_MEDIA" }

Sem o identificador da multimédia na solicitação, a publicação é agendada sem multimédia. Consulta o exemplo completo em Perguntas frequentes e erros comuns ao utilizar a API.

Limitações de publicação

Cada rede social restringe o que as ferramentas de terceiros podem publicar através da sua própria API, por isso nem todas as funcionalidades do planeador estão disponíveis através da API do Metricool. Para consultar a lista por rede de ações de publicação, Inbox e Relatórios não suportadas, vê Limitações da API por rede social.

Os campos específicos de cada rede no corpo da solicitação também variam consoante a rede. Consulta os ficheiros Swagger .yaml e .json na documentação da API para veres os campos disponíveis para cada rede antes de criares a solicitação.

Implementação da API

Para exportar dados do Metricool utilizando a nossa API para outras plataformas, como Excel, Google Sheets, MySQL e outras, segue estes passos gerais:

Obtém o token de acesso em Definições da conta > API, conforme descrito acima.
Configura o cliente HTTP: utiliza uma ferramenta de integração como o Postman ou uma linguagem de programação (por exemplo, Python com requests) e configura o cabeçalho X-Mc-Auth com o teu token.
Envia uma solicitação GET para o endpoint correspondente aos dados que queres (publicações, métricas, relatórios). Todas as chamadas requerem userId e blogId. Utiliza o inspetor do navegador para veres as chamadas que o Metricool faz e os respetivos parâmetros, conforme mostrado em Como obter um endpoint no Metricool para fazer chamadas à API.
Formata os dados: as respostas são geralmente fornecidas em JSON, por isso mapeia os campos para a estrutura esperada pela tua plataforma de destino.
Exporta os dados para a plataforma de destino.

Cada plataforma de destino tem o seu próprio método de integração, mas o fluxo geral segue este esquema.

Documentação

Aqui estão links para a documentação das APIs das plataformas mais utilizadas para gestão de dados:

Monitoriza a utilização e substitui o teu token

Definições da conta > API mostra a tua utilização atual da API e o histórico dos endpoints utilizados. Também podes obter estatísticas de utilização através da API com GET /v2/settings/users/{userId}/api-usage-stats, que aceita os parâmetros from, to e aggregation e devolve as chamadas realizadas por endpoint.

Se precisares de substituir o teu token, podes gerá-lo novamente em Definições da conta > API. A geração de um novo token invalida imediatamente o token anterior e todas as integrações que o utilizam deixam de funcionar até o atualizares. Consulta Gerar novamente o token de ligação da API.

Recursos adicionais

📹 Tutorial da API do Metricool: como começar — EN · ES

Artigos relacionados

Isso foi útil?