> ## Documentation Index
> Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API do Ayrshare

> APIs de redes sociais poderosas que permitem enviar publicações e obter analytics sem esforço. Para desenvolvedores e empresas de todos os tamanhos.

A REST API de Redes Sociais oferece aos desenvolvedores acesso programático a várias redes sociais por meio de uma única interface unificada.
Através da API social do Ayrshare, você pode gerenciar atividades de mídia social, incluindo criar e excluir publicações, obter analytics, engajar com comentários e avaliações, gerenciar mensagens diretas, criar anúncios do Facebook e realizar outras ações em várias plataformas.

Atualmente, a API suporta 13 grandes redes sociais: Bluesky, Facebook, Google Business Profile, Instagram, LinkedIn, Pinterest, Reddit, Snapchat, Telegram, Threads, TikTok, X (antigo Twitter) e YouTube.
Ao integrar com esta API, desenvolvedores podem automatizar tarefas de gerenciamento de mídia social em todas essas plataformas simultaneamente.

Os dados de requisição e resposta das chamadas da API estão em formato JSON, o que permite fácil parsing e processamento na maioria das linguagens de programação.

Se você estiver no plano Launch, Business ou Enterprise, consulte a [Visão geral do plano Business](/multiple-users/business-plan-overview), a [Visão geral do plano Launch](/multiple-users/business-launch-overview) e o [endpoint /profiles da API](/apis/profiles/overview).

## Principais funcionalidades

<ul class="custom-bullets">
  <li>[13 redes sociais suportadas](/introduction#which-social-networks-are-supported).</li>
  <li>Acesso seguro à API usando sua API Key exclusiva.</li>
  <li>Agendamento de publicações para plataformas de mídia social conectadas.</li>
  <li>Publicação automatizada com base em agendamentos predefinidos.</li>
  <li>Suporte a conteúdo em imagem e vídeo, incluindo Reels, Stories e Spotlight.</li>
  <li>Excluir publicações nas redes sociais vinculadas.</li>
  <li>Analytics abrangentes de engajamento por publicação (curtidas, compartilhamentos, etc.).</li>
  <li>Métricas de conta social, incluindo contagem de seguidores e dados demográficos.</li>
  <li>Gerenciamento de comentários: visualizar, adicionar e excluir comentários de publicações.</li>
  <li>Encurtamento opcional de links para todas ou URLs específicas em publicações.</li>
  <li>Integração com Unsplash: adicione imagens específicas ou selecione aleatoriamente com base em palavras-chave.</li>
  <li>Opção de geração automática de hashtags usando palavras-chave relevantes.</li>
  <li>Rastreamento de histórico de publicações, incluindo publicações não feitas via Ayrshare.</li>
  <li>Gerenciamento de avaliações: obter, responder e excluir respostas a avaliações.</li>
  <li>Integração de feeds RSS para publicação automatizada de conteúdo.</li>
  <li>Biblioteca de mídia: envie e armazene fotos e vídeos para uso em publicações.</li>
  <li>[Sistema de verificação de publicações sociais](/testing/post-verification) para manter suas contas sociais seguras.</li>
</ul>

## Plano Business e plano Launch

Recursos do [plano Business](/multiple-users/business-plan-overview) e do [plano Launch](/multiple-users/business-launch-overview) para gerenciar múltiplos usuários e clientes:

<ul class="custom-bullets">
  <li>Permite que os usuários vinculem suas próprias contas de mídia social à sua plataforma.</li>
  <li>Single sign-on seguro usando OAuth para vinculação rápida de contas.</li>
  <li>Criar e remover perfis de usuário programaticamente através da API.</li>
  <li>Acesse analytics avançadas de usuários.</li>
  <li>Suporte a webhooks para atualizações em tempo real.</li>
  <li>Gerenciamento de mensagens diretas nas plataformas suportadas.</li>
  <li>Criar anúncios do Facebook a partir de publicações existentes.</li>
</ul>

Entre em contato para saber mais sobre o [plano Business](https://www.ayrshare.com/business-plan-for-multiple-users/).

## API de Ads

A [API de Ads](/apis/ads/overview) permite criar anúncios do Facebook a partir de publicações existentes.

<ul class="custom-bullets">
  <li>Impulsione publicações para alcançar mais pessoas.</li>
  <li>Gerencie anúncios e acompanhe o desempenho.</li>
  <li>Analise o gasto em anúncios e otimize campanhas.</li>
</ul>

<Card title="API de Ads" icon="code" href="/apis/ads/overview" horizontal>
  Explore a API de Ads
</Card>

## API de Mensagens

Uma [API de mensagens](/apis/messages/overview) unificada para engajar usuários em conversas nos principais canais de mídia social: Facebook, Instagram e X.

<ul class="custom-bullets">
  <li>Envio de mensagens de texto, imagem e vídeo.</li>
  <li>Recuperação de históricos completos de conversas.</li>
  <li>Configuração de respostas automáticas a mensagens.</li>

  <li>
    Recebimento de atualizações em tempo real via webhooks para mensagens recebidas, reações a mensagens e confirmações
    de leitura.
  </li>
</ul>

Esta API simplifica o engajamento com usuários ao centralizar as operações de mensagens de múltiplos canais de mídia social. Saiba mais...

<Card title="API de Mensagens" icon="code" href="/apis/messages/overview" horizontal>
  Explore a API de mensagens unificada
</Card>

## Max Pack

Obtenha ainda mais recursos com o [add-on Max Pack](/additional/maxpack):

<Card title="Max Pack" icon="link" href="/additional/maxpack" horizontal>
  Desbloqueie recursos avançados como geração de conteúdo com IA, analytics aprimoradas e suporte
  expandido a plataformas com nosso add-on Max Pack.
</Card>

## Assista como usar a API social

Se você estiver desenvolvendo em Node.js, confira este vídeo sobre como conectar e publicar publicações no X e no Facebook.

<div class="video-container">
  <iframe width="560" height="315" src="https://www.youtube.com/embed/OMtj2h6sW6U" title="How to Use Ayrshare's Social API" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" />
</div>

## Demonstração da API social

Se você usar Node.js, veja o código de demonstração da API social para começar a construir sua própria integração.

<Card title="Demonstração da API social" icon="github" href="https://github.com/ayrshare/social-api-demo" horizontal>
  Explore nosso código de demonstração em Node.js para acelerar sua integração com a API social
</Card>

## URL base

A URL base para a API do Ayrshare é a mesma para todos os endpoints.

`https://api.ayrshare.com/api`

## Autorização

O Ayrshare autentica as requisições da API por meio de um token Authorization passado no cabeçalho HTTP. Certifique-se de enviar `Bearer` com a API Key. A API Key pode ser encontrada no Ayrshare Dashboard alternando para seu Primary Profile.

Se você for um usuário Business ou Enterprise, poderá criar User Profiles com Profile Keys para gerenciar múltiplos clientes. A Profile Key é usada no cabeçalho de suas requisições.
A API Key também deve ser usada no cabeçalho de suas requisições para User Profiles.

<Tip>
  Planos Premium devem usar apenas a API Key no cabeçalho de suas requisições. Planos Business e Enterprise
  devem usar a Profile Key no cabeçalho de suas requisições ao interagir em nome de um
  User Profile.
</Tip>

### Formato da API Key

`Authorization: Bearer API_KEY` substituindo API\_KEY pela API Key do seu Primary Profile, que pode ser [encontrada no Ayrshare Dashboard](/quickstart#get-your-api-key).

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {"Authorization": "Bearer API_KEY"}
  ```

  ```python Python theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```php PHP theme={"system"}
  $headers = ["Authorization" => "Bearer API_KEY"];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{"Authorization": "Bearer API_KEY"}
  ```

  ```ruby Ruby theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```java Java theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```csharp C# theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```

  ```rust Rust theme={"system"}
  headers = {"Authorization": "Bearer API_KEY"}
  ```
</CodeGroup>

<Note>
  Obtenha sua API Key secreta no Ayrshare Dashboard, na página API Key encontrada no painel de navegação à esquerda.

  Por exemplo, se sua API Key for 2MPXPKQ-S03M5LS-GR5RX5G-AZCK8EA

  Seu cabeçalho deve incluir:

  `Authorization: Bearer 2MPXPKQ-S03M5LS-GR5RX5G-AZCK8EA`
</Note>

### Formato da Profile Key

Uma Profile Key é usada para interagir em nome de um User Profile.
Isso só está disponível para planos Business ou Enterprise.

`Profile-Key: PROFILE_KEY` substituindo PROFILE\_KEY pela [Profile Key](/multiple-users/manage-user-profiles#get-the-profile-key) de um usuário.

**Incluir uma Profile Key no cabeçalho é obrigatório para interagir em nome de um User Profile**.

A falta da API Key do Primary Profile ou o uso da Profile Key no lugar da API Key no cabeçalho resultará em erro.

Veja como estruturar os cabeçalhos para requisições da API:

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \ 
       -H "Profile-Key: PROFILE_KEY" \
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```python Python theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```php PHP theme={"system"}
  $headers = [
    "Authorization" => "Bearer API_KEY",
    "Profile-Key" => "PROFILE_KEY"
  ];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```ruby Ruby theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```java Java theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```csharp C# theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```

  ```rust Rust theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY"
  }
  ```
</CodeGroup>

<Note>
  [Encontre a Profile Key](/multiple-users/manage-user-profiles#get-the-profile-key) no Ayrshare Dashboard, na página Profile Key encontrada no painel de navegação à esquerda.
  Alterne para o Profile que você deseja usar na página User Profile.
  Adicionalmente, a Profile Key é retornada na resposta do endpoint [Criar um User Profile](/apis/profiles/create-profile).

  Você pode então usar a Profile Key no cabeçalho das suas requisições:

  Por exemplo, se sua Profile Key for `AX1XGG-9jK3M5LS-GR5RX5G-LLCK8EA`

  Seu cabeçalho deve incluir tanto a API Key quanto a Profile Key:

  `Authorization: Bearer 2MPXPKQ-S03M5LS-GR5RX5G-AZCK8EA`

  `Profile-Key: AX1XGG-9jK3M5LS-GR5RX5G-LLCK8EA`
</Note>

### Credenciais BYO do X/Twitter

A partir de 31 de março de 2026, todas as operações do X/Twitter através do Ayrshare exigem suas próprias credenciais OAuth 1.0a. Após vincular sua conta do X via OAuth, passe estes 2 cabeçalhos junto com seus cabeçalhos `Authorization` (e `Profile-Key` opcional) em qualquer requisição direcionada ao X/Twitter:

| Cabeçalho                     | Descrição                                       |
| ----------------------------- | ----------------------------------------------- |
| `X-Twitter-OAuth1-Api-Key`    | Sua OAuth 1.0a API Key (Consumer Key)           |
| `X-Twitter-OAuth1-Api-Secret` | Sua OAuth 1.0a API Key Secret (Consumer Secret) |

Estes cabeçalhos são obrigatórios após 31 de março de 2026. As requisições aos endpoints do X/Twitter sem credenciais BYO válidas serão rejeitadas.

<Info>
  **Um único par de chaves, usado em todas as requisições.** Você cria um X Developer App por conta do Ayrshare e usa os mesmos valores de `X-Twitter-OAuth1-Api-Key` e `X-Twitter-OAuth1-Api-Secret` em toda requisição direcionada ao X, independentemente de qual subperfil (`Profile-Key`) seja o destinatário da requisição. Você não gera nem rotaciona chaves por cliente ou por usuário final.
</Info>

Consulte o [Guia de configuração das X BYO Keys](/dashboard/connect-social-accounts/x-twitter-byo-keys) para instruções passo a passo, exemplos de código e resolução de problemas.

Os mesmos dois cabeçalhos se aplicam ao usar o X/Twitter através do [Servidor MCP](/additional/mcp-action-server) — consulte [Conectar & configurar](/additional/mcp-action-connect).

## Content Type

O Content Type deve sempre ser definido como `Content-Type: "application/json"`, a menos que o endpoint especifique outra coisa.

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \ 
       -H "Profile-Key: PROFILE_KEY" \ # Optional
       -H "Content-Type: application/json" \
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```python Python theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json"
  }
  ```

  ```php PHP theme={"system"}
  $headers = [
    "Authorization" => "Bearer API_KEY",
    "Profile-Key" => "PROFILE_KEY", # Optional
    "Content-Type" => "application/json"
  ];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```ruby Ruby theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json"
  }
  ```

  ```java Java theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```csharp C# theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```

  ```rust Rust theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json"
  }
  ```
</CodeGroup>

## Compressão

O Ayrshare suporta compressão para todas as requisições da API.
Para ativar a compressão, defina o cabeçalho `Accept-Encoding` como `deflate, gzip, br`.

```bash theme={"system"}
  Accept-Encoding: "deflate, gzip, br"
```

Isto é recomendado para chamar respostas maiores, como o [endpoint /history](/apis/history/overview).

<ul class="custom-bullets">
  <li>Apenas respostas com mais de 1024 bytes (1KB) são comprimidas.</li>

  <li>
    A ordem de compressão utilizada: Brotli (br) primeiro, depois gzip, depois deflate. Brotli é o algoritmo de
    compressão mais eficiente.
  </li>

  <li>
    O cabeçalho da resposta contém a codificação de conteúdo utilizada. Por exemplo: `content-encoding: br` se
    Brotli foi usado.
  </li>

  <li>
    Saiba mais sobre compressão e os benefícios do seu uso no [Blog do
    Ayrshare](https://www.ayrshare.com/blog/http-compression-in-node-js-a-dive-into-gzip-deflate-and-brotli/).
  </li>
</ul>

<Tip>Não se esqueça de descomprimir corretamente a resposta usando a codificação de conteúdo.</Tip>

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -H "Authorization: Bearer API_KEY" \ 
       -H "Profile-Key: PROFILE_KEY" \ # Optional
       -H "Content-Type: application/json" \
       -H "Accept-Encoding: deflate, gzip, br" \ 
       -X GET https://api.ayrshare.com/api
  ```

  ```javascript JavaScript theme={"system"}
  headers: {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```python Python theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```php PHP theme={"system"}
  $headers = [
    "Authorization" => "Bearer API_KEY",
    "Profile-Key" => "PROFILE_KEY", # Optional
    "Content-Type" => "application/json",
    "Accept-Encoding" => "deflate, gzip, br"
  ];
  ```

  ```go Go theme={"system"}
  headers := map[string]string{
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```ruby Ruby theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", # Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```java Java theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```csharp C# theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```

  ```rust Rust theme={"system"}
  headers = {
    "Authorization": "Bearer API_KEY",
    "Profile-Key": "PROFILE_KEY", // Optional
    "Content-Type": "application/json",
    "Accept-Encoding": "deflate, gzip, br"
  }
  ```
</CodeGroup>

## Tipos de ID

Existem vários tipos de IDs retornados, que podem ser usados em diversos endpoints:

### Ayrshare Post ID

Este ID é gerado pelo Ayrshare e retornado do
[endpoint /post](/apis/post/post) no campo `id`. Este ID facilita
obter analytics da publicação em várias redes sociais, adicionar comentários à
publicação, excluir a publicação, etc. Este é o ID que você usará com mais frequência.

### Social Post ID

Cada rede social atribui seu próprio ID único a publicações e comentários.
Esses IDs são retornados no campo `postIds` dos endpoints /post ou /comments.
Você pode usar esses IDs, ou os que obtiver diretamente das redes sociais, para recuperar dados, como com o [social post ID de analytics](/apis/analytics/social-by-id).

### Ayrshare Comment ID

Este ID é gerado pelo Ayrshare e retornado do
[endpoint /comments](/apis/comments/post-comment) no campo `id`. Este ID facilita
obter analytics do comentário em várias redes sociais, adicionar respostas ao
comentário, excluir o comentário, etc. Este é o ID que você usará com mais frequência.

Frequentemente é usado quando você quer obter detalhes de um comentário específico publicado via Ayrshare.

### Social Comment ID

Cada rede social atribui seu próprio ID único aos comentários.
Esses IDs são retornados no campo `commentId` do [endpoint GET /comments](/apis/comments/get-comments).

Frequentemente é usado quando você quer obter detalhes de um comentário específico publicado fora do Ayrshare.

## Códigos de erro

Os erros retornam com [códigos de status HTTP padrão](https://tools.ietf.org/html/rfc2616#section-10).

Para mais informações:

<Card title="Códigos de status HTTP" icon="link" horizontal href="/errors/errors-http">
  Saiba mais sobre códigos de status HTTP
</Card>

Erros detalhados estão na resposta da REST API, específicos para cada tipo de chamada.

Para mais informações:

<Card title="Códigos de erro do Ayrshare" icon="link" horizontal href="/errors/errors-ayrshare">
  Saiba mais sobre os códigos de erro específicos do Ayrshare
</Card>

## Formato de timestamp

O Ayrshare usa Zulu Time, também conhecido como UTC (Tempo Universal Coordenado) ou uma string de data no formato ISO 8601, para referências de horário precisas e sem ambiguidade entre diferentes fusos horários.

Por exemplo, use o formato `YYYY-MM-DDThh:mm:ssZ` e envie como `2026-07-08T12:30:00Z`.
Consulte [utctime](https://www.utctime.net/) para mais exemplos.

Você pode converter o formato UTC para seu horário local na linguagem de programação de sua escolha. Por exemplo, em JavaScript:

```javascript theme={"system"}
const convertToLocalTime = (isoString) => {
  // Create a new Date object from the ISO string
  const date = new Date(isoString);

  // Extract local time components
  const localDate = date.toLocaleDateString();
  const localTime = date.toLocaleTimeString();

  // Combine the local date and time
  const localDateTime = `${localDate} ${localTime}`;

  return localDateTime;
};
```

## Postman

Você pode usar o Postman para testar suas chamadas da REST API.

<Card title="Postman" icon="link" horizontal href="/testing/postman">
  Aprenda a usar o Postman com nossa API
</Card>

## Publicações, imagens e vídeos aleatórios

Confira o [guia de início rápido](/quickstart#publish-test-posts) sobre como enviar publicações, imagens ou vídeos aleatórios ao testar.

## Pacotes

Temos pacotes para Node.js e Python, além de guias para Bubble.io, Airtable e Make para facilitar as chamadas RESTful.

<CardGroup cols={2}>
  <Card title="Pacote NPM para Node" icon="cube" iconType="duotone" href="/packages-guides/nodejs" horizontal>
    Integre usando nosso pacote NodeJS
  </Card>

  <Card title="Pacote PyPI para Python" icon="cube" iconType="duotone" href="/packages-guides/python" horizontal>
    Integre usando nosso pacote Python
  </Card>

  <Card title="Guia do Airtable" icon="book-open" iconType="duotone" href="/packages-guides/airtable" horizontal>
    Aprenda a usar o Ayrshare com o Airtable
  </Card>

  <Card title="Plugin & Guia do Bubble" icon="cube" iconType="duotone" href="/packages-guides/bubble" horizontal>
    Aprenda a usar o Ayrshare com o Bubble.io
  </Card>

  <Card title="Guia do Make" icon="book-open" iconType="duotone" href="/packages-guides/make" horizontal>
    Aprenda a usar o Ayrshare com o Make
  </Card>

  <Card title="Guia do Notion" icon="book-open" iconType="duotone" href="/packages-guides/notion" horizontal>
    Aprenda a usar o Ayrshare com o Notion
  </Card>

  <Card title="Guia do FlutterFlow" icon="book-open" iconType="duotone" href="/packages-guides/flutterflow" horizontal>
    Aprenda a usar o Ayrshare com o FlutterFlow
  </Card>

  <Card title="Guia do Retool" icon="book-open" iconType="duotone" href="/packages-guides/retool" horizontal>
    Aprenda a usar o Ayrshare com o Retool
  </Card>
</CardGroup>