Gerenciar a lista de e-mails permitidos de um flipbook

O que você pode fazer

Quando um flipbook é restrito por e-mail, só os endereços na sua lista de permitidos podem abri-lo. A API oferece quatro formas de gerenciar essa lista sem nunca tocar no painel:

• Ler a lista atual, para você nunca ter de controlá-la por conta própria.
• Adicionar um ou mais endereços (sem mexer nos que já estão lá).
• Remover endereços específicos.
• Substituir a lista inteira em uma única chamada.

Este guia passa por cada uma, o formato exato da requisição, as respostas que você recebe de volta e a pegadinha que mais confunde as pessoas (a diferença entre adicionar e substituir).

Antes de começar

Você vai precisar de:

• Uma chave de API — enviada como cabeçalho X-Api-Key em toda requisição. (Sua chave está na página de API da sua conta.)
• O flipbookId de um flipbook que seja restrito por e-mail. A lista de permitidos rege o acesso de visualização em flipbooks restritos por e-mail.
• Todas as requisições vão para a URL base https://go.fliplink.me.

O campo EmailsAllowed nas requisições de escrita é form-urlencoded (não JSON) e separado por ponto e vírgula (alice@corp.com;bob@corp.com). Vírgulas são aceitas e convertidas automaticamente em ponto e vírgula.

Os quatro endpoints em resumo

Leia a lista atual

Comece sempre por aqui — leia a lista para saber o estado exato dela antes de mudar qualquer coisa.

curl -X GET 'https://go.fliplink.me/api/get-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com"], "Count": 2 }

EmailsAllowed volta como um array JSON limpo (não uma string com ponto e vírgula), e Count é o tamanho dele.

Adicione endereços (sem apagar o resto)

Para dar acesso a novas pessoas mantendo todo mundo que já está na lista, use Add. Isso é aditivo — não remove ninguém.

curl -X POST 'https://go.fliplink.me/api/add-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=carol@corp.com;dan@corp.com'

Resposta (a lista completa e atualizada):

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "carol@corp.com", "dan@corp.com"], "Count": 4 }

Remova endereços específicos

Para revogar o acesso de pessoas indicadas, use Delete. Só os endereços que você listar são removidos; todos os outros permanecem.

curl -X DELETE 'https://go.fliplink.me/api/delete-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=carol@corp.com'

Resposta:

{ "Result": "OK", "EmailsAllowed": ["alice@corp.com", "bob@corp.com", "dan@corp.com"], "Count": 3 }

Substitua a lista inteira ⚠️

Set sobrescreve toda a lista de permitidos com exatamente os endereços que você enviar. Aqui está a pegadinha: enviar um único endereço remove todos os outros.

# Isto NÃO adiciona uma pessoa — deixa a lista APENAS com essa pessoa.
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=alice@corp.com'

Depois dessa chamada, alice@corp.com é o único endereço que pode ver o flipbook. Use Set só quando você realmente quiser definir a lista completa do zero (por exemplo, ao popular um flipbook novinho). Para as mudanças do dia a dia do tipo "libere esta pessoa / revogue aquela pessoa", use Add e Delete.

Para limpar a lista por completo, envie um valor vazio:

curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/96464' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed='

Erros possíveis

• Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key está presente e correto.
• flipbookId desconhecido (ou que não pertence à sua chave) → HTTP 200 com { "Result": "ERROR", "Message": "Item not found" }.

Uma regra prática: Result: "OK" significa que a mudança foi aplicada; Result: "ERROR" significa que não foi — leia a Message para saber o motivo.

Padrão recomendado

Para mudanças seguras e previsíveis:

1. GET na lista atual.
2. Decida quem adicionar ou remover.
3. Use Add / Delete para mudanças pontuais (elas nunca mexem no resto da lista).
4. Reserve o Set para quando você realmente quiser substituir a lista inteira de uma vez.
5. GET de novo para confirmar o estado final.

Esse ciclo de "ler → mudar → reler" faz com que você nunca precise controlar a lista no seu próprio sistema, e nunca apague o acesso por acidente usando Set quando queria Add.