> ## 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.

# API do Pinterest

> Opções para publicar usando a API do Pinterest

## Publicando um Pin de imagem no Pinterest

A API do Pinterest exige que uma imagem seja incluída na publicação. Outros parâmetros são opcionais.
Consulte as [Diretrizes de mídia do Pinterest](/media-guidelines/pinterest) e a [Autorização do Pinterest](/dashboard/connect-social-accounts/pinterest) para mais informações.

```json Pinterest Post theme={"system"}
{
  "post": "The best Pinterest API ever!", // Maximum 500 characters or empty string
  "platforms": ["pinterest"],
  "mediaUrls": ["https://images.ayrshare.com/imgs/GhostBusters.jpg"]
}
```

## Opções do Pinterest

Você pode definir opções adicionais para uma publicação usando o parâmetro `pinterestOptions`.

```json Pinterest Post theme={"system"}
{
  "post": "The best Pinterest API ever!", // Maximum 500 characters or empty string
  "platforms": ["pinterest"],
  "mediaUrls": ["https://images.ayrshare.com/imgs/GhostBusters.jpg"],
  "pinterestOptions": {
    "altText": ["This is my best pic", "😃 here is the next one"], // maximum 500 characters
    "boardId": "93383204522",
    "carouselOptions": [
      {
        "title": "Image 1",
        "link": "https://www.cnn.com",
        "description": "Super Image 1"
      },
      {
        "title": "Image 2",
        "link": "https://www.google.com",
        "description": "Super Image 2"
      }
    ],
    "link": "https://www.ayrshare.com", // maximum 2048 characters
    "note": "Private note", // maximum 1000 characters
    "thumbNail": "https://images.ayrshare.com/imgs/GhostBusters.jpg",
    "title": "A Pinterest Board for You" // maximum 100 characters
  }
}
```

As opções do Pinterest são campos opcionais que podem ser usados para controlar a publicação.

<ParamField body="altText" type="array of strings">
  O texto alternativo para imagens e vídeos, voltado para acessibilidade e leitores de tela. Máximo de 500 caracteres.

  Consulte [Texto alternativo do Pinterest](/apis/post/social-networks/pinterest#alternative-text) para mais informações.
</ParamField>

<ParamField body="boardId" type="string">
  Publique em outro Pinterest Board do usuário especificando o ID do endpoint /user/details.

  Se não for especificado, publica no board vinculado por padrão.

  Consulte [Pinterest Board ID](/apis/post/social-networks/pinterest#board-id) para mais informações.
</ParamField>

<ParamField body="carouselOptions" type="array of objects">
  Adicione até 5 imagens como um carrossel do Pinterest com títulos, links e descrições opcionais.

  Cada objeto pode conter: `title`, `link` e `description`.

  Consulte [Carrossel de imagens do Pinterest](/apis/post/social-networks/pinterest#pinterest-image-carousel) para mais informações.
</ParamField>

<ParamField body="link" type="string">
  A URL de destino para a qual os usuários serão direcionados ao clicarem na imagem do Pin. Máximo de 2048 caracteres.

  Cria um link clicável associado ao seu Pin.

  Consulte [Pin Link](/apis/post/social-networks/pinterest#pin-link) para mais informações.
</ParamField>

<ParamField body="note" type="string">
  Adicione notas privadas a Pins individuais que só você e os colaboradores do board podem ver. Máximo de 1000 caracteres.

  Consulte [Pin Note](/apis/post/social-networks/pinterest#pin-note) para mais informações.
</ParamField>

<ParamField body="thumbNail" type="string">
  Define uma thumbnail para Pins de vídeo. Deve ser PNG ou JPG, com as mesmas dimensões do vídeo, com menos de 10MB.

  Obrigatório para Pins de vídeo.

  Consulte [Pin de vídeo (Thumbnail)](/apis/post/social-networks/pinterest#video-pin-thumbnail) para mais informações.
</ParamField>

<ParamField body="title" type="string">
  O título do Pin exibido na seção "Add your title". Máximo de 100 caracteres.

  Consulte [Pin Title](/apis/post/social-networks/pinterest#pin-title) para mais informações.
</ParamField>

<sup>\*</sup>Links no campo `post` não são clicáveis. Use o campo `link` para adicionar um
link clicável ao Pin.

Consulte as [Diretrizes de mídia do Pinterest](/media-guidelines/pinterest) para mais informações.

## Texto alternativo

Adicione texto alternativo (alt text) a uma imagem ou vídeo do Pinterest. O alt text do Pinterest é um recurso de acessibilidade usado para fornecer informações adicionais ao usuário e para leitores de tela.

Use `altText` no objeto `pinterestOptions`.

```json Pinterest Alt Text theme={"system"}
{
  "pinterestOptions": {
    "altText": ["This is my best pic", "😃 here is the next one"]
  }
}
```

O alt text é limitado a 500 caracteres.

## ID do Board

Publique em outro Pinterest Board do usuário especificando o ID obtido do endpoint [/user/details](/apis/user/pinterest-board). Caso contrário, publica no board vinculado por padrão.

Use `boardId` no objeto `pinterestOptions`.

```json Pinterest Board ID theme={"system"}
{
  "pinterestOptions": {
    "boardId": "93383204522"
  }
}
```

## Limites de caracteres

Consulte [Limites de caracteres do Pinterest](/help-center/technical-support/character_limits#pinterest-character-limits) para mais informações.

## Pin Link

A URL de destino para a qual os usuários serão direcionados ao clicarem na imagem do Pin. Isso cria um link clicável associado ao seu Pin. Tamanho máximo de 2048 caracteres.

Use `link` no objeto `pinterestOptions`.

```json Pin Link theme={"system"}
{
  "pinterestOptions": {
    "link": "https://www.ayrshare.com"
  }
}
```

## Pin Note

Você pode adicionar notas privadas a Pins individuais em seus boards. Apenas você e os colaboradores do board poderão vê-las.

Use `note` no objeto `pinterestOptions`.

```json Pin Note theme={"system"}
{
  "pinterestOptions": {
    "note": "Private note for collaborators"
  }
}
```

## Carrossel de imagens do Pinterest

Publique até cinco imagens como um carrossel do Pinterest. Ao adicionar mais de uma URL de mídia, um carrossel é criado automaticamente. Você também pode adicionar parâmetros opcionais do carrossel. Veja abaixo.

```json Pinterest Carousel Post theme={"system"}
{
  "post": "Carousel Time",
  "platforms": ["pinterest"],
  "mediaUrls": [
    "https://img.ayrshare.com/random/photo-1.jpg",
    "https://img.ayrshare.com/random/photo-2.jpg"
  ],
  "pinterestOptions": {
    "carouselOptions": [
      // optional
      {
        "title": "Image 1",
        "link": "https://www.cnn.com",
        "description": "Super Image 1"
      },
      {
        "title": "Image 2",
        "link": "https://www.google.com",
        "description": "Super Image 2"
      }
    ]
  }
}
```

O campo opcional `carouselOptions` recebe um array de objetos. Cada objeto do carrossel corresponde à string equivalente na URL de mídia; por exemplo, o primeiro objeto do carrossel se refere à primeira string `mediaUrl`.

<ul class="custom-bullets">
  <li>`title`: O título da imagem.</li>
  <li>`link`: O link de destino externo da imagem.</li>
  <li>`description`: A descrição da imagem.</li>
</ul>

## Menções no Pinterest

Embora você possa adicionar um @handle a uma publicação do Pinterest, o Pinterest não suporta a resolução de menções no texto da publicação.
O @handle permanecerá como texto simples.

## Pin Title

O título do Pin a ser exibido. Aparece na seção "Add your title" de um novo Pin. Máximo de 100 caracteres.

Use `title` no objeto `pinterestOptions`.

```json Pin Title theme={"system"}
{
  "pinterestOptions": {
    "title": "A Pinterest Board for You"
  }
}
```

## Pin de vídeo (Thumbnail)

Um vídeo pode ser publicado como Pin usando o campo padrão `mediaUrls` no [endpoint /post](/apis/post/post). Além disso, uma URL de imagem de thumbnail **deve ser incluída** com o vídeo, com um Content-Type de mídia válido, como `image/jpeg`.
Consulte os [requisitos](/media-guidelines/pinterest).

```json Video Pin with Thumbnail theme={"system"}
{
  "pinterestOptions": {
    // required
    "thumbNail": "https://images.unsplash.com/photo-1513093496871-0a81425386e5?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=MnwxNjQ1ODN8MHwxfHJhbmRvbXx8fHx8fHx8fDE2Mzg0ODAzNDA&ixlib=rb-1.2.1&q=80&w=400"
  }
}
```

Informações adicionais sobre [publicar Pins usando a API](https://www.ayrshare.com/blog/pinterest-api-integration-on-ayrshare/).

Se seu vídeo não terminar em uma extensão de vídeo conhecida, como mp4, use o parâmetro `isVideo`. Consulte o [endpoint /post](/apis/post/post) para detalhes.
