Consultas de referência (modelos, skins, moedas, música)

O que você pode fazer

Quatro endpoints somente leitura retornam as listas de referência de que você depende ao configurar um flipbook. Cada um lista as opções válidas para uma configuração específica, então você pode escolher um ID ou nome da lista e passá-lo ao endpoint de escrita correspondente:

• List templates — os modelos de flipbook reutilizáveis salvos na sua conta.
• List skins — as skins/temas de visualizador disponíveis, cada uma com a URL de fundo incluída.
• List currencies — as moedas disponíveis ao vender um flipbook.
• List background music — as faixas de música de fundo embutidas que você pode anexar a um visualizador de flipbook.

Antes de começar

• Autentique-se com sua chave de API — enviada como cabeçalho X-Api-Key ou como Authorization: Bearer YOUR_API_KEY.
• URL base: https://go.fliplink.me.
• São consultas GET sem corpo de requisição e sem parâmetros de caminho — as opções são passadas como query strings onde indicado.

List templates

Lista os modelos de flipbook reutilizáveis salvos na sua conta. Filtre por DocType. Use o ID de um modelo com os fluxos de save-as-template / criação.

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

O parâmetro de query DocType aceita 0 = Flipbook (padrão) ou 1 = Document.

List skins

Lista as skins/temas de visualizador disponíveis; cada linha carrega a URL de fundo incluída na skin. Use o Name de uma skin com o set-skin.

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

O parâmetro de query Type é um boolean: false = skins de Flipbook, true = skins de Document.

List currencies

Lista as moedas disponíveis ao vender um flipbook (para as configurações de venda/checkout).

curl -X GET 'https://go.fliplink.me/api/list-currencies' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

List background music

Lista as faixas de música de fundo embutidas que você pode anexar a um visualizador de flipbook.

curl -X GET 'https://go.fliplink.me/api/list-background-music' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

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. Isso vale para os quatro endpoints.