Referência da API do FlipLink

Perfil

Quem sou eu

Retorna a conta dona da chave de API — IDs de usuário/fornecedor, nome, e-mail, marca, URL do app e o tamanho máximo de upload do plano (MaxFileSizeMB).

GEThttps://go.fliplink.me/api/whoami

Pré-requisitos — nenhum. Esta é a chamada raiz: ela autentica sua chave de API, o pré-requisito de todos os outros endpoints.

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter detalhes da assinatura Obter perfil

GET/api/whoami

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

Exemplo de resposta200 OK

{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Obter perfil

Retorna o perfil da conta vinculada à chave de API — nome de exibição, telefone e URL da imagem de perfil.

GEThttps://go.fliplink.me/api/get-profile

Pré-requisitosQuem sou eu(uma chave de API válida)→Obter perfil

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir perfil (parcial)Quem sou eu

GET/api/get-profile

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

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Definir perfil (parcial)

Atualização parcial — os campos omitidos mantêm seus valores atuais. Pelo menos um campo é obrigatório.

PUThttps://go.fliplink.me/api/set-profile

Pré-requisitosQuem sou eu(uma chave de API válida)→Definir perfil (parcial)

Parâmetros do corpo

`Name`	ex.: `Mark Stevens`
`Phone`phone	ex.: `+14155550142`
`ProfileImage`URL	ex.: `https://...`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter perfil

PUT/api/set-profile

curl -X PUT 'https://go.fliplink.me/api/set-profile' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://...'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros do corpo

Name

Phonephone

ProfileImageURL

Assinatura e pagamentos

Obter detalhes da assinatura

Retorna seu plano e cota atuais — nome do plano, status, taxas, data da próxima fatura, tamanho máximo de arquivo, máximo de itens/CNAMEs e flags de recursos.

GEThttps://go.fliplink.me/api/get-subscription-details

Pré-requisitosQuem sou eu(uma chave de API válida)→Obter detalhes da assinatura

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar pagamentos Quem sou eu

GET/api/get-subscription-details

curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Subscription": {
    "BrandName": "",
    "Name": "Your Account",
    "Mobile": "",
    "SubscriptionPlan": "LTD Individual",
    "SubscriptionFees": "USD 39.00",
    "Tax": "",
    "SubscriptionID": "#20000",
    "ActiveFrom": "12 Jun 2026",
    "Status": "Active",
    "NextInvoice": "01 Jan 2050",
    "Email": "you@example.com",
    "PhotoIMG": "/Content/assetsNew/media/avatars/blank.png",
    "MaxFileSizeBytes": 157286400,
    "MaxFileSize": "150",
    "MaxCNAME": "Unlimited",
    "AdvancedSharing": "Yes",
    "LeadEmailVerification": "Yes",
    "IsLTD": "Yes",
    "MaxItems": "200"
  }
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Listar pagamentos

Retorna seu histórico de cobranças — cada compra/renovação de plano com ID do pedido, valor, plano, data e quantidade de itens.

GEThttps://go.fliplink.me/api/list-payments

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar pagamentos

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter detalhes da assinatura

GET/api/list-payments

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

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [
    {
      "OrderID": "#10001",
      "Amount": "USD 39.00",
      "Plan": "LTD Individual / 822bf1b6",
      "Date": "12 Jun 2026",
      "DateIso": "2026-06-12T00:00:00+05:30",
      "InvoiceURL": "",
      "ItemCount": 100
    }
  ]
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Itens — Criar

Criar por arquivo

Cria um flipbook (ou documento) a partir de um PDF enviado, no formato multipart/form-data. O arquivo é armazenado, uma miniatura é gerada e o registro é criado.

Observações
- Se você recebe um Flipbook ou um Document é definido pelo cabeçalho Host da requisição — go.fliplink.me (padrão) retorna Flipbooks, go.doclink.me retorna Documents.
- *_Count / *_Max / *_Left refletem a cota do seu plano após esta criação.
- Use o ID retornado para as chamadas seguintes (set-meta, set-cta-primary, save-as-template, etc.).
- O tamanho máximo de arquivo varia por plano (veja MaxFileSizeMB em who-am-i).

POSThttps://go.fliplink.me/api/create-by-file

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo

Corpo (multipart/form-data)

`File`file	—
`Name`	ex.: `My Document`
`Title`	ex.: `My Title`
`DocType`enum	Flipbook ou Document. Em go.doclink.me é sempre tratado como Document.Um destes: `Flipbook`, `Document`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Uploaded file is not a readable PDF`{ "Result": "ERROR", "Message": "File is not a valid PDF." }`
413	Upload exceeds the plan's max file size`{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosCriar por URL Obter um Definir meta

POST/api/create-by-file

curl -X POST 'https://go.fliplink.me/api/create-by-file' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file' \
  -F 'Name=My Document' \
  -F 'Title=My Title' \
  -F 'DocType=Flipbook'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Corpo (form-data)

Filefile

Name

Title

DocTypechoose oneFlipbook ou Document. Em go.doclink.me é sempre tratado como Document.

Criar por URL

Cria um flipbook (ou documento) a partir da URL de um PDF. O servidor baixa FileURL, faz o upload para o S3, gera uma miniatura e registra o item.

Observações
- O prefixo do nome do campo Flipbooks_* vs Documents_* é definido pelo cabeçalho Host da requisição — go.fliplink.me (padrão) retorna Flipbooks, go.doclink.me retorna Documents.
- *_Count / *_Max / *_Left refletem a cota do plano da conta após esta criação.
- A URL de origem precisa responder em até 60s — origens lentas ou inacessíveis falham com Source URL timed out after 60s. Para origens instáveis, prefira /api/create-by-file.

POSThttps://go.fliplink.me/api/create-by-url

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por URL

Parâmetros do corpo

`FileURL`URL	ex.: `https://example.com/document.pdf`
`Name`	ex.: `My Document`
`Title`	ex.: `My Title`
`DocType`enum	ex.: `Flipbook`Um destes: `Flipbook`, `Document`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	FileURL host is private / not allowed`{ "Result": "ERROR", "Message": "FileURL host is not allowed." }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosCriar por arquivo Obter um Definir meta

POST/api/create-by-url

curl -X POST 'https://go.fliplink.me/api/create-by-url' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FileURL=https://example.com/document.pdf' \
  --data-urlencode 'Name=My Document' \
  --data-urlencode 'Title=My Title' \
  --data-urlencode 'DocType=Flipbook'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros do corpo

FileURLURL

Name

Title

DocTypechoose one

Itens — Ler

Obter um

Retorna o registro completo de um único flipbook/documento por ID — todas as colunas armazenadas: título, URLs, contagens de visualizações/leads/vendas, pasta e flags de status. O registro completo é retornado dentro de um objeto `Item` com cerca de 190 colunas; o exemplo abaixo é um subconjunto resumido e representativo.

GEThttps://go.fliplink.me/api/get/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Obter um

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosBuscar por URL Obter URL do PDF Obter link de compartilhamento Listar

GET/api/get/{flipbookId}

curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "Name": "My Document",
    "Title": "My Title",
    "DocType": "Flipbook",
    "IsPublished": true,
    "Pages": 8,
    "Folder": "Marketing",
    "SkinName": "Light Wood",
    "CustomURL": "my-document-96216",
    "ValidTillDate": "",
    "NoOfViews": 42,
    "NoOfLeads": 3,
    "NoOfSales": 0,
    "IsForSale": false,
    "IsLeadCapture": true,
    "IsPasswordProtected": false,
    "BookLayout": 1,
    "ScrollBehaviour": 1,
    "IsRightToLeft": false,
    "CoverType": "1",
    "PageDepth": "1",
    "FullURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172",
    "EmbedURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172"
  }
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Buscar por URL

Procura um flipbook pela sua URL pública/de compartilhamento e retorna o registro completo (mesmo formato do get).

GEThttps://go.fliplink.me/api/find-by-url

Pré-requisitosQuem sou eu(uma chave de API válida)→Buscar por URL

Parâmetros de query

URLURL URL completa do visualizador, uma URL de CNAME ou apenas o slug CustomURL puro. O servidor usa o último segmento do caminho como slug.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter um Obter link de compartilhamento

GET/api/find-by-url

curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https%3A%2F%2Fgo.fliplink.me%2Fview%2F%3Cslug%3E' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "VendorID": "20000",
    "FilePDF": "/docs/20001/894abc58~demo_multipage.pdf",
    "Name": " coverage 20-Jun",
    "CreatedOn": "/Date(1781945608053)/",
    "NoOfViews": 1,
    "IsActive": true,
    "CustomURL": "your-flipbook-slug",
    "Title": "",
    "Description": " desc",
    "SkinID": -1,
    "LogoIMG": "",
    "LogoURL": "https://fliplink.me",
    "BackgroundIMG": "",
    "BackgroundDisplayFit": "",
    "BackgroundFillDirection": "",
    "ColorPanel": "#5A5F63",
    "ColorBackground": "#F2F2F2",
    "ColorLink": "#75869C",
    "FaviconIMG": "",
    "IsShare": true,
    "IsPrint": true,
    "IsDownload": false,
    "IsTextSelection": true,
    "IsThumbnails": true,
    "IsSound": false,
    "IsFullscreen": false,
    "IsZoom": false,
    "IsSearch": true,
    "IsPinnedThumbnails": false,
    "IsCTAButton": false,
    "CTAButtonText": "Buy",
    "CTAButtonColor": "#3366FF",
    "CTAButtonTextColor": "       ",
    "CTAButtonURL": "https://fliplink.me",
    "IsPasswordProtected": false,
    "Password": "",
    "IsLeadCapture": true,
    "LeadCaptureTitle": "",
    "IsLeadEmail": true,
    "IsLeadEmailMandatory": true,
    "IsLeadName": true,
    "IsLeadNameMandatory": false,
    "IsLeadPhone": false,
    "IsLeadPhoneMandatory": false,
    "IsLeadCompany": false,
    "IsLeadCompanyMandatory": false,
    "IsLeadDate": false,
    "IsLeadDateMandatory": false,
    "IsLeadCustom1": false,
    "IsLeadCustom1Mandatory": false,
    "Custom1Label": "",
    "IsLeadCustom2": false,
    "IsLeadCustom2Mandatory": false,
    "Custom2Label": "",
    "IsLeadPrivacyPolicy": false,
    "PrivacyPolicyURL": "",
    "IsLeadAllowSkip": true,
    "PageTurnMode": "Flip",
    "BookLayout": 1,
    "Shadowdepth": 1,
    "IsFixedZoomMode": false,
    "IsHardCover": false,
    "IsBookThickness": true,
    "IsLinkHighlight": true,
    "IsRightToLeft": false,
    "IMGPdf": "/Content/assets/media/users/no-image.png",
    "Pages": 8,
    "FacebookAnalyticsCode": "",
    "GoogleAnalyticsCode": "",
    "GoogleTagManager": "",
    "Folder": "-Folder",
    "PabblyWebhookURL_NewLead": "https://example.com/webhook-apitest",
    "TitleColor": "#3366FF",
    "CNAME": "",
    "IsNoIndex": false,
    "BackgroundMusic": "",
    "BackgroundMusicCustom": "",
    "AutoFlipInSecs": 0,
    "PwdTitle": "This is a private flipbook.\r\nTo view it, please enter the password.",
    "PwdPlaceholder": "Password",
    "PwdButton": "Submit",
    "LeadEmail": "Email",
    "LeadName": "Name",
    "LeadPhone": "Phone",
    "LeadCompany": "Company",
    "LeadDate": "Date",
    "LeadButton": "Submit",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsSendEmailOnView": false,
    "LeadFormAfterPages": 0,
    "CustomLoadingText": " loading",
    "IsShareButtons": true,
    "IsNotes": false,
    "IsCTAButton2": false,
    "CTAButtonText2": "More",
    "CTAButtonColor2": "#3366FF",
    "CTAButtonTextColor2": "       ",
    "CTAButtonURL2": "",
    "IsVerifyEmail": false,
    "IsVerifyMobile": false,
    "TwillioAPIKey": "",
    "IsShowControls": true,
    "NotificationsEmail": "antifragiletech@gmail.com",
    "GoogleSheetURL": "",
    "GoogleSheetIDKey": "",
    "GoogleSheetName": "",
    "PrivacyPolicyText": "",
    "PageDepth": "1",
    "CoverType": "1",
    "IsPublished": true,
    "LeadPhoneCountry": "",
    "LeadAfterPages": 0,
    "EmailsAllowed": "",
    "EmailVerifyTitleText": "antifragiletech@gmail.com",
    "EmailVerifyButtonText": "antifragiletech@gmail.com",
    "LeadSkipText": "",
    "OrdPos": 1,
    "IsStarred": false,
    "IsShowLogoMobile": true,
    "PreviewPDF": "",
    "IsForSale": false,
    "SaleCurr": "USD",
    "SaleAmount": 10,
    "SalePageTitle": "",
    "SaleAccessPageTitle": "",
    "SalePurchaseButtonText": "",
    "SaleButtonText": "",
    "SaleAccessButtonText": "",
    "SaleButtonColor": "#3366FF",
    "SaleGatewayName": "",
    "SaleGatewayKey": "",
    "SaleGatewaySecret": "",
    "EmailLeadSubject": "",
    "EmailLeadBody": " body",
    "EmailViewSubject": "antifragiletech@gmail.com",
    "EmailViewBody": "antifragiletech@gmail.com",
    "EmailSaleSubject": "antifragiletech@gmail.com",
    "EmailSaleBody": "antifragiletech@gmail.com",
    "TopLeft": "",
    "TopRight": "",
    "BottomLeft": "",
    "BottomRight": "",
    "IsCTAHiddenInPreview": false,
    "IsApprovalButton": false,
    "ApprovalButtonText": "Approve Document",
    "ApprovalButtonColor": "#000000",
    "ApprovalButtonTextColor": "#FFFFFF",
    "EmailApproveRequestSubject": "Document Approval Request: ##DOCUMENT_TITLE##",
    "EmailApproveRequestBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveRemindSubject": "Pending Document Approval: ##DOCUMENT_TITLE##",
    "EmailApproveRemindBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveSubmitSubject": "Document Approved: ##DOCUMENT_TITLE##",
    "EmailApproveSubmitBody": "<p>Hi,</p>\n<p>We are pleased to inform you that the following document has been approved:</p>\n<p>Name: <strong>##DOCU...",
    "IsBackgroundMusicLoop": false,
    "IsNavFirstLast": true,
    "IsShareFacebook": true,
    "IsShareTwitter": true,
    "IsShareWhatsApp": true,
    "IsShareTelegram": false,
    "IsShareLinkedIn": false,
    "IsSharePinterest": false,
    "IsShareReddit": false,
    "IsShareTumblr": false,
    "IsShareMessenger": false,
    "IsShareEmail": false,
    "IsShareLine": false,
    "IsShareWeChat": false,
    "IsShareInstagram": false,
    "IsShareFlipboard": false,
    "IsShareGeneral": false,
    "ScrollBehaviour": 1,
    "AIProvider": "",
    "AIKey": "",
    "IsVA": false,
    "VAButtonText": "",
    "VAButtonColor": "#3366FF",
    "VAButtonTextColor": "#3366FF",
    "VAText": "",
    "VAEmbeddings": "",
    "VAButtonStatus1": "0",
    "VAButtonStatus2": "0",
    "VAButtonStatus3": "0",
    "VAButtonStatus4": "0",
    "FrontPDF": "/docs/20001/f9496e75~dummy.pdf",
    "MiddlePDF": "/docs/20001/0b14ad4d~demo_multipage.pdf",
    "BackPDF": "/docs/20001/68504e6d~dummy.pdf",
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "WebhookURL_NewLead": "https://example.com/webhook-apitest",
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

URLURLURL completa do visualizador, uma URL de CNAME ou apenas o slug CustomURL puro. O servidor usa o último segmento do caminho como slug.

Listar

Lista seus flipbooks/documentos com paginação (PageNo/PageSize). Cada item inclui IDs, título, URLs, contagens de visualizações/leads/vendas, pasta e flags de status.

GEThttps://go.fliplink.me/api/list

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar

Parâmetros de query

`Folder`	—
`SearchText`	—
`PageNo`number	ex.: `1`
`PageSize`number	ex.: `25`
`Offset`number	ex.: `0`
`SortBy`enum	Opcional. Um destes: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Vazio = ordenação padrão; valores desconhecidos voltam ao padrão.Um destes: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`
`SortOrder`enum	Opcional. `ASC` ou `DESC`. Ignorado se SortBy estiver vazio. Valores desconhecidos voltam ao padrão silenciosamente.Um destes: `ASC`, `DESC`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter um Listar pastas

GET/api/list

curl -X GET 'https://go.fliplink.me/api/list?Folder=%3CFolder%3E&SearchText=%3CSearchText%3E&PageNo=1&PageSize=25&Offset=0&SortBy=%3CSortBy%3E&SortOrder=%3CSortOrder%3E' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": 93286,
      "Name": "INSPECT matrix Document - Copy 000",
      "Title": "MX Title",
      "CreatedOn": "Jun 12 2026  4:48PM",
      "CreatedOnIso": "2026-06-12T22:18:49.723+05:30",
      "CreatedDate": "Jun 12, 2026",
      "CreatedTime": " 4:48PM",
      "ValidTillDate": "",
      "NoOfViews": 0,
      "CustomURL": "0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "Password": "",
      "FilePDF": "/docs/20001/0DF318DC~dummy.pdf",
      "NoOfLeads": 0,
      "NoOfSales": 0,
      "FullURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "EmbedURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "IMGPdf": "/Content/assets/media/users/no-image.png",
      "Pages": 0,
      "IsUnpublished": "",
      "Folder": "",
      "IsTemplate": false,
      "CNAMEMessage": "",
      "DocType": "Document",
      "DocTypeColor": "danger",
      "SSL": "No",
      "CompressDataKey": "",
      "Optimised": "",
      "IsPinnedThumbnails": true,
      "IsApprovalButton": true,
      "NoOfApprovals": 0,
      "FrontPDF": "/docs/20001/730d7569~dummy.pdf",
      "MiddlePDF": "/docs/20001/4b34cbea~dummy.pdf",
      "BackPDF": "/docs/20001/e4454ad1~dummy.pdf"
    }
  ],
  "TotalRecordCount": 14,
  "TotalItems": 14,
  "UserItems": 14,
  "PageSize": 10,
  "Capped": false
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

Folder

SearchText

PageNonumber

PageSizenumber

Offsetnumber

SortBychoose oneOpcional. Um destes: `Name`, `DocType`, `CreatedOn`, `NoOfViews`, `NoOfLeads`. Vazio = ordenação padrão; valores desconhecidos voltam ao padrão.

SortOrderchoose oneOpcional. `ASC` ou `DESC`. Ignorado se SortBy estiver vazio. Valores desconhecidos voltam ao padrão silenciosamente.

Obter URL do PDF

Retorna a URL pública no S3 do PDF principal do item (versão mesclada, se houver capa/contracapa).

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Obter URL do PDF

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter um Remover capa/contracapa Definir capa/contracapa (arquivo)

GET/api/get-pdf/{flipbookId}

curl -X GET 'https://go.fliplink.me/api/get-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Obter link de compartilhamento

Retorna a URL pública do visualizador do flipbook (o prefixo de domínio personalizado/host mais o slug de compartilhamento do flipbook).

Resposta: { "Result": "OK", "URL": "https://go.fliplink.me/view/<guid>" }.

GEThttps://go.fliplink.me/api/get-share-link/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Obter link de compartilhamento

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter um Definir URL personalizada

GET/api/get-share-link/{flipbookId}

curl -X GET 'https://go.fliplink.me/api/get-share-link/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "URL": "https://go.fliplink.me/view/your-flipbook-slug"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Itens — Modificar

Duplicar

Cria uma ou mais cópias do flipbook no servidor — cada cópia ganha seu próprio ID e URL de compartilhamento. Você pode duplicar até 20 de uma vez (Count).

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Duplicar

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

Countnumber 1–500 (limitado no servidor)

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter um Criar por arquivo

POST/api/duplicate/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/duplicate/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Count=3'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

Countnumber1–500 (limitado no servidor)

Substituir PDF (arquivo)

Upload multipart. Mescla automaticamente de novo com a capa/contracapa existentes, se houver.

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Substituir PDF (arquivo)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Corpo (multipart/form-data)

Filefile —

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Uploaded file is not a readable PDF`{ "Result": "ERROR", "Message": "File is not a valid PDF." }`
413	Upload exceeds the plan's max file size`{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosSubstituir PDF (URL)Definir capa/contracapa (arquivo)Remover capa/contracapa Obter URL do PDF

PUT/api/replace-pdf/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/replace-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Corpo (form-data)

Filefile

Substituir PDF (URL)

Substitui o PDF de um flipbook existente por um que o servidor baixa de uma URL que você fornece. O flipbook mantém seu ID, configurações e link de compartilhamento.

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Substituir PDF (URL)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FileURL ex.: https://example.com/new.pdf

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosSubstituir PDF (arquivo)Definir capa/contracapa (URL)Obter URL do PDF

PUT/api/replace-pdf-by-url/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'File=https://example.com/new.pdf'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FileURL

Salvar como modelo (alternar)

Marca o flipbook como um modelo reutilizável (Status=true) ou o remove dos modelos (Status=false). Os modelos aparecem em list-templates e podem servir de base para novos flipbooks.

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Salvar como modelo (alternar)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

Statustrue | false true/false. Padrão true se omitido.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar modelos Criar por arquivo

PUT/api/save-as-template/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/save-as-template/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Saved as template"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

Statustrue / falsetrue/false. Padrão true se omitido.

Atribuir a uma pasta

Move o flipbook para uma pasta para organização. As pastas são criadas sob demanda — atribua a um nome de pasta que ainda não existe e ela é criada automaticamente (não há uma chamada separada de 'criar pasta'). Envie Folder vazio para remover o flipbook da pasta. Uma pasta existe apenas enquanto houver pelo menos um flipbook nela, então mover o último flipbook para fora faz a pasta sumir de list-folders. Os nomes de pasta podem conter / (ex.: Marketing/Q2).

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Atribuir a uma pasta

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

Folder Nome da pasta para onde mover o flipbook — criada se não existir (ou reutilize um nome de list-folders). Envie vazio para limpar a atribuição.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar pastas Definir membro da equipe (criar ou atualizar)

PUT/api/assign-to-folder/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FolderNome da pasta para onde mover o flipbook — criada se não existir (ou reutilize um nome de list-folders). Envie vazio para limpar a atribuição.

Definir capa/contracapa (arquivo)

Capa e/ou contracapa opcionais — pelo menos uma é obrigatória. Mescla de novo com o PDF principal existente.

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir capa/contracapa (arquivo)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Corpo (multipart/form-data)

`Front`file	—
`Back`file	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Uploaded file is not a readable PDF`{ "Result": "ERROR", "Message": "File is not a valid PDF." }`
413	Upload exceeds the plan's max file size`{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir capa/contracapa (URL)Remover capa/contracapa Substituir PDF (arquivo)Obter URL do PDF

PUT/api/set-front-back-page/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Corpo (form-data)

Frontfile

Backfile

Definir capa/contracapa (URL)

Variante por URL de set-front-back-page — anexa páginas de capa/contracapa a partir da URL de um PDF remoto, em vez de um arquivo enviado.

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir capa/contracapa (URL)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`Front`URL	ex.: `https://example.com/front.pdf`
`Back`URL	ex.: `https://example.com/back.pdf`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir capa/contracapa (arquivo)Remover capa/contracapa Obter URL do PDF

PUT/api/set-front-back-page-by-url/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FrontURL

BackURL

Remover capa/contracapa

Remove a capa/contracapa, restaurando o FilePDF para o PDF principal sem capa (MiddlePDF). Idempotente — um flipbook sem capa retorna OK e não muda nada. Retorna { Result, Message, URL (URL do PDF principal no S3) }. Os objetos antigos no S3 (mesclado/capa/contracapa) não são excluídos.

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Remover capa/contracapa

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir capa/contracapa (arquivo)Obter URL do PDF

PUT/api/clear-front-back-page/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Definir expiração / Remover expiração

Define ou remove a expiração automática de um flipbook. Envie Days + Hours como inteiros; Days=-1, Hours=0 remove a expiração por completo.

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir expiração / Remover expiração

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`Days`number	Use -1 para remover a expiração
`Hours`number	Opcional, padrão 0

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir fixação (alternar)Definir publicação (publicar / despublicar)

PUT/api/set-expiry/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-expiry/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

DaysnumberUse -1 para remover a expiração

HoursnumberOpcional, padrão 0

Definir fixação (alternar)

Fixa ou desafixa o flipbook (o estado de favorito) para que ele suba ao topo do seu painel.

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir fixação (alternar)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar

PUT/api/set-pin/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Itens — Excluir

Excluir

Exclui permanentemente o registro do flipbook no banco de dados. Observação: os arquivos no S3 NÃO são removidos automaticamente.

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Excluir

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosExcluir leads (em massa)Listar

DELETE/api/delete/{flipbookId}

curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

CNAME (domínios personalizados)

Adicionar CNAME

Vincula um domínio personalizado (CNAME) já ativado a um flipbook. O domínio precisa primeiro ser adicionado e verificado pelo painel web (que provisiona DNS + SSL); este endpoint apenas persiste o vínculo — ele não verifica DNS nem emite certificados.

Pré-condições:
- O CNAME já precisa existir na sua conta (adicionado pelo painel). Caso contrário: Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- Precisa estar dentro do limite de CNAMEs do seu plano.

Parâmetros:
- CNAME (obrigatório) — hostname completo, ex.: docs.example.com
- IsCloudflare (opcional, padrão 0).

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Adicionar CNAME

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`CNAME`	ex.: `docs.example.com`
`IsCloudflare`true \| false	Opcional. 0 (padrão) ou 1. Passe 1 se o seu DNS estiver atrás do proxy da Cloudflare.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar CNAMEs Excluir CNAME Definir URL personalizada

POST/api/add-cname/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/add-cname/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

CNAME

IsCloudflaretrue / falseOpcional. 0 (padrão) ou 1. Passe 1 se o seu DNS estiver atrás do proxy da Cloudflare.

Listar CNAMEs

Todos os CNAMEs personalizados do chamador. Cada item: { CNAME, Documents (quantidade de flipbooks ativos), FlipbookIDs ([...] dos IDs de flipbooks ativos vinculados a esse CNAME) }.

GEThttps://go.fliplink.me/api/list-cnames

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar CNAMEs

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosAdicionar CNAME Excluir CNAME

GET/api/list-cnames

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

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Excluir CNAME

Remove o vínculo de um domínio personalizado (CNAME) de um ou de todos os seus flipbooks. Dois modos:

Em massa (padrão): passe CNAME=<host> e deixe FlipbookID em branco — remove esse CNAME de todos os flipbooks que você possui.
Por flipbook: passe FlipbookID=<id> — o CNAME é obtido a partir desse flipbook. Use para uma ação 'Remover CNAME' por linha.

Resposta (por flipbook): { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
Resposta (em massa): { "Result": "OK", "Message": "CNAME removed successfully" }
Faltando os dois: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

Observação: passe o CNAME como parâmetro de query (não como segmento da URL) para evitar problemas com os pontos do hostname.

DELETEhttps://go.fliplink.me/api/delete-cname

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar CNAMEs(encontre o CNAME / FlipbookID)→Excluir CNAME

Parâmetros de query

`CNAME`	Obrigatório no modo EM MASSA (remove o CNAME de todos os flipbooks que você possui). Ignorado quando FlipbookID > 0 — nesse caso o CNAME é obtido daquele flipbook.
`FlipbookID`number	Opcional. Passe um ID de flipbook > 0 para remover o CNAME APENAS daquele flipbook (modo por flipbook). Deixe em branco/omita/0 para o modo em massa (remover de todos).

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosAdicionar CNAME Listar CNAMEs

DELETE/api/delete-cname

curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=%3CFlipbookID%3E' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

CNAMEObrigatório no modo EM MASSA (remove o CNAME de todos os flipbooks que você possui). Ignorado quando FlipbookID > 0 — nesse caso o CNAME é obtido daquele flipbook.

FlipbookIDnumberOpcional. Passe um ID de flipbook > 0 para remover o CNAME APENAS daquele flipbook (modo por flipbook). Deixe em branco/omita/0 para o modo em massa (remover de todos).

Pastas

Listar pastas

Lista suas pastas, cada uma como { Folder (nome), URL (um GUID da pasta) }. As pastas derivam das atribuições de flipbooks (criadas via assign-to-folder), então uma pasta vazia não é listada. Os nomes de pasta alimentam assign-to-folder (para colocar um flipbook) e set-team-member (para limitar o acesso de um membro da equipe).

GEThttps://go.fliplink.me/api/list-folders

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar pastas

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosAtribuir a uma pasta Definir membro da equipe (criar ou atualizar)

GET/api/list-folders

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

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Membros da equipe

Listar membros da equipe

Lista os membros da equipe (usuários do fornecedor) na sua conta com os detalhes de acesso, incluindo as pastas a que cada membro está atribuído. As senhas nunca são retornadas. Filtre por IsActive.

GEThttps://go.fliplink.me/api/list-team-members

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar membros da equipe

Parâmetros de query

IsActivetrue | false 1=ativos (padrão), 0=inativos

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir membro da equipe (criar ou atualizar)Obter membro da equipe Definir membro da equipe como ativo Excluir membro da equipe

GET/api/list-team-members

curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

IsActivetrue / false1=ativos (padrão), 0=inativos

Obter membro da equipe

Retorna um único membro da equipe pelo seu ID de membro (o ID de list-team-members) — nome, e-mail, status ativo e as pastas a que o membro está atribuído. Um membro da equipe fica restrito às pastas definidas via set-team-member (o campo Folders), então só consegue acessar flipbooks dentro dessas pastas. As senhas nunca são retornadas. O memberId é o ID do membro da equipe (de List Team Members) — não um ID de flipbook; passar um ID de flipbook retorna "Team member not found". O membro é retornado dentro de um objeto Item; Folders é uma lista separada por vírgulas das pastas que ele pode acessar (vazio = sem restrição de pasta).

GEThttps://go.fliplink.me/api/get-team-member/{memberId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Definir membro da equipe (criar ou atualizar)(crie um membro primeiro)→Obter membro da equipe

Parâmetros de caminho

memberIdnumber ID do membro da equipe (de list-team-members). NÃO é um ID de flipbook.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	No team member with that ID (e.g. you passed a flipbook ID)`{ "Result": "ERROR", "Message": "Team member not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar membros da equipe Definir membro da equipe (criar ou atualizar)Listar pastas

GET/api/get-team-member/{memberId}

curl -X GET 'https://go.fliplink.me/api/get-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

memberIdrequirednumberID do membro da equipe (de list-team-members). NÃO é um ID de flipbook.

Definir membro da equipe (criar ou atualizar)

Cria um novo membro da equipe (usuário do fornecedor) ou atualiza um existente — controlando quem pode acessar sua conta e, pelo campo Folders, a quais pastas ele fica limitado (um membro só vê flipbooks dentro das pastas atribuídas a ele). Uma entrada de log de auditoria é gravada em caso de sucesso.

Erros comuns: o nome do membro é um único campo Name — não existe FirstName/LastName. Folders é uma lista separada por vírgulas de nomes de pasta de List Folders (ex.: Marketing,Sales); deixe vazio para não restringir as pastas. Criar um membro retorna { Result:"OK", Message:"Team member created" } (o caminho de atualização — quando ID é informado — retorna "Updated successfully"). O e-mail do membro não pode já pertencer a um usuário do FlipLink, e e-mails com alias + são rejeitados.

POSThttps://go.fliplink.me/api/set-team-member

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar pastas(nomes para o escopo de Folders)→Definir membro da equipe (criar ou atualizar)

Parâmetros do corpo

`Name`	ex.: `Jane`
`Email`email	ex.: `jane@example.com`
`ID`number	Omita ou -1 para criar. >0 para atualizar.
`Password`	Texto puro; criptografado no servidor. Vazio na atualização mantém o existente.
`ProfileImage`URL	—
`Folders`	Pastas às quais este membro fica restrito — uma lista delimitada de nomes de pasta (de list-folders). O membro só consegue acessar flipbooks dentro dessas pastas.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar membros da equipe Obter membro da equipe Definir membro da equipe como ativo Excluir membro da equipe Listar pastas

POST/api/set-team-member

curl -X POST 'https://go.fliplink.me/api/set-team-member' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'ProfileImage=<ProfileImage>' \
  --data-urlencode 'Folders=<Folders>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Team member created"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros do corpo

Name

Emailemail

IDnumberOmita ou -1 para criar. >0 para atualizar.

PasswordTexto puro; criptografado no servidor. Vazio na atualização mantém o existente.

ProfileImageURL

FoldersPastas às quais este membro fica restrito — uma lista delimitada de nomes de pasta (de list-folders). O membro só consegue acessar flipbooks dentro dessas pastas.

Definir membro da equipe como ativo

Ativa ou desativa um membro da equipe, controlando se ele pode entrar e acessar a conta.

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Definir membro da equipe (criar ou atualizar)(crie um membro primeiro)→Definir membro da equipe como ativo

Parâmetros de caminho

memberIdnumber ID do membro da equipe (de list-team-members). NÃO é um ID de flipbook.

Parâmetros do corpo

IsActivetrue | false ex.: true

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar membros da equipe Definir membro da equipe (criar ou atualizar)Excluir membro da equipe

PUT/api/set-team-member-active/{memberId}

curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

memberIdrequirednumberID do membro da equipe (de list-team-members). NÃO é um ID de flipbook.

Parâmetros do corpo

IsActivetrue / false

Excluir membro da equipe

Exclusão suave (desativação). Membros da equipe nunca são excluídos de forma definitiva — isso desativa o membro (um alias REST de set-team-member-active com IsActive=false). O histórico de pagamentos e as referências de auditoria permanecem intactos, e ele pode ser reativado depois via PUT /api/set-team-member-active (IsActive=true).

Resposta: { "Result": "OK", "Message": "Team member deactivated" }.

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Definir membro da equipe (criar ou atualizar)(crie um membro primeiro)→Excluir membro da equipe

Parâmetros de caminho

memberIdnumber ID do membro da equipe (de list-team-members). NÃO é um ID de flipbook.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir membro da equipe como ativo Listar membros da equipe

DELETE/api/delete-team-member/{memberId}

curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Team member deactivated"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

memberIdrequirednumberID do membro da equipe (de list-team-members). NÃO é um ID de flipbook.

Leads e vendas

Listar leads

Lista as submissões de captura de leads coletadas pelos seus flipbooks. Retorna Items[] mais um esquema dinâmico Columns[] (para montar uma tabela) e TotalRecordCount. Suporta paginação e exportação em CSV via IsDownload.

GEThttps://go.fliplink.me/api/list-leads

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar leads

Parâmetros de query

`ItemIDs`	IDs de flipbooks separados por vírgula OU por barra vertical (vazio = todos)
`SearchText`	—
`PageNo`number	ex.: `1`
`Offset`number	ex.: `0`
`IsDownload`true \| false	ex.: `true`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosExcluir lead Excluir leads (em massa)Definir captura de leads (base)

GET/api/list-leads

curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

ItemIDsIDs de flipbooks separados por vírgula OU por barra vertical (vazio = todos)

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

Listar vendas

Lista os registros de venda/compra dos seus flipbooks (e-mail do comprador, flipbook, valor, data) mais as definições de coluna da tabela de vendas. Suporta paginação e exportação em CSV via IsDownload.

GEThttps://go.fliplink.me/api/list-sales

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar vendas

Parâmetros de query

`ItemIDs`	—
`SearchText`	—
`PageNo`number	ex.: `1`
`Offset`number	ex.: `0`
`IsDownload`true \| false	ex.: `true`
`IsAbandoned`true \| false	true → retorna vendas de carrinho abandonado em vez de vendas concluídas

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir configurações de venda Registrar compra de flipbook

GET/api/list-sales

curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

ItemIDs

SearchText

PageNonumber

Offsetnumber

IsDownloadtrue / false

IsAbandonedtrue / falsetrue → retorna vendas de carrinho abandonado em vez de vendas concluídas

Excluir lead

Exclui um único lead capturado pelo seu ID. O segmento do caminho é o leadId; passe também o Email do lead e seu FlipbookID como parâmetros de query.

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar leads(obtenha um ID de lead)→Excluir lead

Parâmetros de caminho

leadIdnumber O ID do lead (o LeadID de list-leads).

Parâmetros de query

`Email`email	ex.: `foo@example.com`
`FlipbookID`number	ex.: `{{flipbookId}}`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar leads Excluir leads (em massa)

DELETE/api/delete-lead/{leadId}

curl -X DELETE 'https://go.fliplink.me/api/delete-lead/{leadId}?Email=foo%40example.com&FlipbookID=%7B%7BflipbookId%7D%7D' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

leadIdrequirednumberO ID do lead (o LeadID de list-leads).

Parâmetros de query

Emailemail

FlipbookIDnumber

Excluir leads (em massa)

Exclui leads em massa por filtro. PELO MENOS UM destes é OBRIGATÓRIO: FlipbookID/Email/DateFrom/DateTo — uma chamada sem filtro é rejeitada (não há caminho de 'excluir tudo'). Sempre limitado ao fornecedor. Retorna { Result, Deleted (quantidade) }. Também limpa registros filhos (log de visualizações / cliques de CTA / log de exportação para planilha).

DELETEhttps://go.fliplink.me/api/delete-leads

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(limite por FlipbookID)→Excluir leads (em massa)

Parâmetros de query

`FlipbookID`number	Opcional. Excluir leads apenas deste flipbook.
`Email`email	Opcional. E-mail com correspondência EXATA.
`DateFrom`	Opcional. Excluir leads capturados nesta data ou depois (corresponde a Lead.CreatedOn). Qualquer data interpretável, ex.: 2026-01-01 ou 2026-01-01T00:00:00Z.
`DateTo`	Opcional. Excluir leads capturados nesta data ou antes.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar leads Excluir lead

DELETE/api/delete-leads

curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID=%7B%7BflipbookId%7D%7D&Email=%3CEmail%3E&DateFrom=%3CDateFrom%3E&DateTo=%3CDateTo%3E' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

FlipbookIDnumberOpcional. Excluir leads apenas deste flipbook.

EmailemailOpcional. E-mail com correspondência EXATA.

DateFromOpcional. Excluir leads capturados nesta data ou depois (corresponde a Lead.CreatedOn). Qualquer data interpretável, ex.: 2026-01-01 ou 2026-01-01T00:00:00Z.

DateToOpcional. Excluir leads capturados nesta data ou antes.

Registrar compra de flipbook

Registra uma venda (compra) concluída de flipbook — use para registrar compras feitas pelo seu próprio fluxo de pagamento, sem passar pelo checkout da Stripe do FlipLink.

Parâmetro de caminho: {flipbookId} — o flipbook que está sendo marcado como comprado.

Corpo (urlencoded):
- Email — e-mail do comprador (obrigatório)
- PaymentRef — a referência do seu gateway de pagamento, ex.: um ID de PaymentIntent da Stripe (obrigatório)

Resposta (sucesso): { "Result": "OK", "Message": "Purchase recorded successfully" }
Resposta (erro): { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

Erros comuns: envie PaymentRef; NÃO envie Amount/Currency — esses são derivados no servidor a partir da sua referência de pagamento.

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Registrar compra de flipbook

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`Email`email	Endereço de e-mail do comprador (obrigatório).
`PaymentRef`	Referência do payment intent do gateway (obrigatório). Para a Stripe, é o ID do PaymentIntent (`pi_...`).

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir configurações de venda Definir gateway de venda Listar vendas

POST/api/set-flipbook-purchase/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailemailEndereço de e-mail do comprador (obrigatório).

PaymentRefReferência do payment intent do gateway (obrigatório). Para a Stripe, é o ID do PaymentIntent (`pi_...`).

Consultas

Listar modelos

Lista os modelos de flipbook reutilizáveis salvos na sua conta. Filtre por DocType (0 = todos). Use o ID de um modelo com os fluxos de save-as-template / create.

GEThttps://go.fliplink.me/api/list-templates

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar modelos

Parâmetros de query

DocTypenumber 0 = Flipbook (padrão), 1 = Document

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosSalvar como modelo (alternar)Criar por arquivo

GET/api/list-templates

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

Exemplo de resposta200 OK

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

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

DocTypenumber0 = Flipbook (padrão), 1 = Document

Listar skins

Lista as skins/temas de visualizador disponíveis; cada linha traz a URL do plano de fundo incluído na skin. Use o nome de uma skin com set-skin.

GEThttps://go.fliplink.me/api/list-skins

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar skins

Parâmetros de query

Typetrue | false 0=skins de Flipbook, 1=skins de Document

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir skin

GET/api/list-skins

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

Exemplo de resposta200 OK

{
  "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"
    }
  ]
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de query

Typetrue / false0=skins de Flipbook, 1=skins de Document

Listar moedas

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

GEThttps://go.fliplink.me/api/list-currencies

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar moedas

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir configurações de venda

GET/api/list-currencies

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

Exemplo de resposta200 OK

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

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Listar músicas de fundo

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

GEThttps://go.fliplink.me/api/list-background-music

Pré-requisitosQuem sou eu(uma chave de API válida)→Listar músicas de fundo

Sem parâmetros.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir música de fundo

GET/api/list-background-music

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

Exemplo de resposta200 OK

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

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Seções — Marca e conteúdo

Definir meta

Define o título e os metadados de SEO do flipbook — Title, Description, TitleColor e a flag IsPublished.

Observação: isso sobrescreve Title/Description/TitleColor. Para mudar apenas o estado de publicação, use set-published.

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir meta

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`Title`	—
`Description`	—
`TitleColor`	—
`IsPublished`true \| false	ex.: `false`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir publicação (publicar / despublicar)

PUT/api/set-meta/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-meta/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=<Title>' \
  --data-urlencode 'Description=<Description>' \
  --data-urlencode 'TitleColor=<TitleColor>' \
  --data-urlencode 'IsPublished=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

Title

Description

TitleColor

IsPublishedtrue / false

Definir publicação (publicar / despublicar)

Publica ou despublica o flipbook — altera APENAS a flag de publicação, mantendo Title/Description/TitleColor intactos (diferente de set-meta). Use para (re)publicar um flipbook, ex.: um que voltou despublicado de create-by-file.

PUThttps://go.fliplink.me/api/set-published/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir publicação (publicar / despublicar)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsPublishedtrue | false true/1 = publicar, false/0 = despublicar (obrigatório).

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir meta

PUT/api/set-published/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-published/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsPublishedtrue / falsetrue/1 = publicar, false/0 = despublicar (obrigatório).

Definir skin

Aplica uma skin/tema de visualizador ao flipbook; o servidor resolve o nome da skin para o ID dela.

Erros comuns: o campo é SkinName (a string de list-skins), não um ID numérico.

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Listar skins(escolha um SkinName)→Definir skin

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

SkinName De /api/list-skins → coluna Name

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar skins

PUT/api/set-skin/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-skin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName=<SkinName>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

SkinNameDe /api/list-skins → coluna Name

Definir logo

Define a imagem de logo exibida na área de cabeçalho/marca do visualizador do flipbook.

PUThttps://go.fliplink.me/api/set-logo/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir logo

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`LogoIMG`URL	—
`LogoURL`URL	—
`IsShowLogoMobile`true \| false	ex.: `false`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir favicon Definir imagem de fundo

PUT/api/set-logo/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-logo/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=<LogoIMG>' \
  --data-urlencode 'LogoURL=<LogoURL>' \
  --data-urlencode 'IsShowLogoMobile=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

LogoIMGURL

LogoURLURL

IsShowLogoMobiletrue / false

Definir imagem de fundo

Define a imagem de fundo do visualizador a partir de uma URL que você fornece (não há galeria nativa).

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir imagem de fundo

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

BackgroundIMGURL URL da imagem OU URL de placeholder como https://plchldr.co/i/100x100?text=&bg=HEX

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

PUT/api/set-background-image/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-background-image/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG=<BackgroundIMG>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

BackgroundIMGURLURL da imagem OU URL de placeholder como https://plchldr.co/i/100x100?text=&bg=HEX

Definir favicon

Define o favicon (ícone da aba do navegador) usado pela página de visualizador hospedada do flipbook.

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir favicon

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FaviconIMGURL —

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir logo

PUT/api/set-favicon/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-favicon/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG=<FaviconIMG>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FaviconIMGURL

Definir aparência da página

Configura a aparência das páginas no visualizador — plano de fundo, sombra das páginas, espaçamento e outras opções de visual. Os valores são armazenados literalmente; itens mais antigos podem retornar outros valores (ex.: regular, ou o numérico 1) ao serem lidos via Get one.

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir aparência da página

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`PageDepth`enum	flat \| thin \| thickUm destes: `flat`, `thin`, `thick`
`CoverType`enum	soft \| hardUm destes: `soft`, `hard`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir navegação do leitor

PUT/api/set-page-appearance/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

PageDepthchoose oneflat | thin | thick

CoverTypechoose onesoft | hard

Definir texto de carregamento

Define o texto personalizado exibido na tela de carregamento do visualizador.

Erros comuns: o campo é CustomLoadingText, não LoadingText.

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir texto de carregamento

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

CustomLoadingText —

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

PUT/api/set-loading-text/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-loading-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText=<CustomLoadingText>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

CustomLoadingText

Definir URL personalizada

Define o slug personalizado (vanity) da URL de compartilhamento do flipbook. Precisa ser único; um slug em uso retorna Result:ERROR.

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir URL personalizada

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

CustomURL —

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Custom URL already taken`{ "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosObter link de compartilhamento Adicionar CNAME

PUT/api/set-custom-url/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=<CustomURL>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

CustomURL

Definir PDF de prévia

Define o PDF de prévia mostrado aos leitores antes da captura de lead / pagamento. Limpo automaticamente se tanto a captura de leads quanto o modo de venda estiverem desativados.

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir PDF de prévia

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

PreviewPDFURL —

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir PDF de imagem Definir captura de leads (base)Definir configurações de venda

PUT/api/set-preview-pdf/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=<PreviewPDF>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

PreviewPDFURL

Definir PDF de imagem

Define o PDF só de imagem/prévia usado para miniaturas e prévias. Envie vazio para manter o PDF de imagem existente.

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir PDF de imagem

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IMGPdfURL —

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir PDF de prévia

PUT/api/set-image-pdf/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=<IMGPdf>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IMGPdfURL

Seções — Visualizador e leitor

Definir controles do visualizador

Mostra ou oculta cada botão da barra de ferramentas do visualizador (baixar, imprimir, compartilhar, tela cheia, zoom, miniaturas, etc.).

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir controles do visualizador

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsShowControls`true \| false	ex.: `true`
`IsPrint`true \| false	ex.: `false`
`IsDownload`true \| false	ex.: `false`
`IsThumbnails`true \| false	ex.: `true`
`IsSearch`true \| false	ex.: `true`
`IsSound`true \| false	ex.: `true`
`IsFullscreen`true \| false	ex.: `true`
`IsZoom`true \| false	ex.: `true`
`IsNotes`true \| false	ex.: `false`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir navegação do leitor

PUT/api/set-viewer-controls/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsShowControlstrue / false

IsPrinttrue / false

IsDownloadtrue / false

IsThumbnailstrue / false

IsSearchtrue / false

IsSoundtrue / false

IsFullscreentrue / false

IsZoomtrue / false

IsNotestrue / false

Definir navegação do leitor

Configura a navegação do leitor no visualizador — miniaturas de páginas, sumário e como os leitores avançam entre as páginas.

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir navegação do leitor

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsNavFirstLast`true \| false	ex.: `true`
`BookLayout`enum	1=página única, 2=página duplaUm destes: `1`, `2`
`IsRightToLeft`true \| false	ex.: `false`
`ScrollBehaviour`number	Modo de rolagem numérico

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir controles do visualizador Definir virada automática Definir aparência da página

PUT/api/set-reader-navigation/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsNavFirstLasttrue / false

BookLayoutchoose one1=página única, 2=página dupla

IsRightToLefttrue / false

ScrollBehaviournumberModo de rolagem numérico

Definir virada automática

Ativa ou desativa a virada automática de páginas no visualizador e seu intervalo.

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir virada automática

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

AutoFlipInSecsnumber MILISSEGUNDOS, apesar do nome. 0 = desligado, 3000 = 3s, 5000 = 5s, etc.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir navegação do leitor

PUT/api/set-auto-flip/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

AutoFlipInSecsnumberMILISSEGUNDOS, apesar do nome. 0 = desligado, 3000 = 3s, 5000 = 5s, etc.

Definir música de fundo

Define ou remove a faixa de música de fundo que toca no visualizador. Veja list-background-music para as faixas disponíveis.

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Listar músicas de fundo(escolha uma faixa)→Definir música de fundo

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`BackgroundMusic`	Nome de arquivo de uma faixa predefinida (de /api/list-background-music)
`BackgroundMusicCustom`URL	URL de música personalizada enviada por você
`IsBackgroundMusicLoop`true \| false	ex.: `false`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar músicas de fundo

PUT/api/set-background-music/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-background-music/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=<BackgroundMusic>' \
  --data-urlencode 'BackgroundMusicCustom=<BackgroundMusicCustom>' \
  --data-urlencode 'IsBackgroundMusicLoop=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

BackgroundMusicNome de arquivo de uma faixa predefinida (de /api/list-background-music)

BackgroundMusicCustomURLURL de música personalizada enviada por você

IsBackgroundMusicLooptrue / false

Definir layout de cabeçalho/rodapé

Define o conteúdo exibido nos quatro cantos (cabeçalho/rodapé) do visual do visualizador.

PUThttps://go.fliplink.me/api/set-header-footer-layout/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir layout de cabeçalho/rodapé

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`TopLeft`	—
`TopRight`	—
`BottomLeft`	—
`BottomRight`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

PUT/api/set-header-footer-layout/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=<TopLeft>' \
  --data-urlencode 'TopRight=<TopRight>' \
  --data-urlencode 'BottomLeft=<BottomLeft>' \
  --data-urlencode 'BottomRight=<BottomRight>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

TopLeft

TopRight

BottomLeft

BottomRight

Seções — CTAs

Definir CTA primário

Configura o botão de chamada para ação (CTA) primário no visualizador (texto, URL, posição, cor).

Erros comuns: os campos são IsCTAButton, CTAButtonText, CTAButtonURL (mais posição/cor) — não Text/URL/Position.

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir CTA primário

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsCTAButton`true \| false	ex.: `false`
`CTAButtonText`	—
`CTAButtonColor`	—
`CTAButtonURL`URL	Prefixos mailto: / tel: são normalizados automaticamente no servidor
`CTAButtonTextColor`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir CTA secundário Definir regras de prévia do CTA

PUT/api/set-cta-primary/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=<CTAButtonText>' \
  --data-urlencode 'CTAButtonColor=<CTAButtonColor>' \
  --data-urlencode 'CTAButtonURL=<CTAButtonURL>' \
  --data-urlencode 'CTAButtonTextColor=<CTAButtonTextColor>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsCTAButtontrue / false

CTAButtonText

CTAButtonColor

CTAButtonURLURLPrefixos mailto: / tel: são normalizados automaticamente no servidor

CTAButtonTextColor

Definir CTA secundário

Configura o botão de chamada para ação (CTA) secundário no visualizador.

Erros comuns: o botão secundário usa os campos com sufixo 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2.

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir CTA secundário

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsCTAButton2`true \| false	ex.: `false`
`CTAButtonText2`	—
`CTAButtonColor2`	—
`CTAButtonTextColor2`	—
`CTAButtonURL2`URL	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir CTA primário Definir regras de prévia do CTA

PUT/api/set-cta-secondary/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=<CTAButtonText2>' \
  --data-urlencode 'CTAButtonColor2=<CTAButtonColor2>' \
  --data-urlencode 'CTAButtonTextColor2=<CTAButtonTextColor2>' \
  --data-urlencode 'CTAButtonURL2=<CTAButtonURL2>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsCTAButton2true / false

CTAButtonText2

CTAButtonColor2

CTAButtonTextColor2

CTAButtonURL2URL

Definir regras de prévia do CTA

Configura quando o CTA é mostrado aos leitores — ex.: após N páginas ou N segundos (as regras do gate de prévia).

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir regras de prévia do CTA

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsCTAHiddenInPreviewtrue | false ex.: false

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir CTA primário Definir captura de leads (base)

PUT/api/set-cta-preview-rules/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsCTAHiddenInPreviewtrue / false

Seções — Controle de acesso

Definir acesso por senha

Liga/desliga a proteção por senha do flipbook e define a senha de acesso.

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir acesso por senha

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsPasswordProtected`true \| false	ex.: `false`
`Password`	—
`PwdTitle`	—
`PwdPlaceholder`	—
`PwdButton`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir lista de e-mails permitidos Definir indexação

PUT/api/set-password-access/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-password-access/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'PwdTitle=<PwdTitle>' \
  --data-urlencode 'PwdPlaceholder=<PwdPlaceholder>' \
  --data-urlencode 'PwdButton=<PwdButton>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsPasswordProtectedtrue / false

Password

PwdTitle

PwdPlaceholder

PwdButton

Definir indexação

Controla a indexação do flipbook hospedado pelos mecanismos de busca. IsNoIndex=true adiciona um noindex de robots para que a página não seja indexada.

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir indexação

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsNoIndextrue | false ex.: false

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

PUT/api/set-indexing/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-indexing/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNoIndex=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsNoIndextrue / false

Definir lista de e-mails permitidos

Restringe o acesso ao visualizador a uma lista de e-mails permitidos (visualização restrita).

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir lista de e-mails permitidos

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailsAllowed Lista delimitada de e-mails permitidos

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir acesso por senha Definir verificação de lead

PUT/api/set-email-allow-list/{flipbookId}

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

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailsAllowedLista delimitada de e-mails permitidos

Seções — Captura de leads

Definir captura de leads (base)

Ativa e configura o formulário base de captura de leads (o gate que coleta os dados do leitor antes que ele leia).

Erros comuns: a flag de ativação é IsLeadCapture, não IsEnabled.

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsLeadCapture`true \| false	ex.: `false`
`LeadCaptureTitle`	—
`IsLeadAllowSkip`true \| false	ex.: `false`
`LeadSkipText`	—
`LeadFormAfterPages`number	ex.: `0`
`LeadAfterPages`number	ex.: `0`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir campos de lead Definir campos personalizados de lead Definir rótulos de lead Definir privacidade do lead Definir verificação de lead Definir webhook de lead Definir Google Sheets de leads Listar leads

PUT/api/set-lead-capture/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=false' \
  --data-urlencode 'LeadCaptureTitle=<LeadCaptureTitle>' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=<LeadSkipText>' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsLeadCapturetrue / false

LeadCaptureTitle

IsLeadAllowSkiptrue / false

LeadSkipText

LeadFormAfterPagesnumber

LeadAfterPagesnumber

Definir campos de lead

Alterna cada campo padrão de captura de leads (nome, e-mail, telefone, empresa, etc.) e se ele é obrigatório.

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir campos de lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsLeadEmail`true \| false	ex.: `true`
`IsLeadEmailMandatory`true \| false	ex.: `true`
`IsLeadName`true \| false	ex.: `true`
`IsLeadNameMandatory`true \| false	ex.: `false`
`IsLeadPhone`true \| false	ex.: `false`
`IsLeadPhoneMandatory`true \| false	ex.: `false`
`IsLeadCompany`true \| false	ex.: `false`
`IsLeadCompanyMandatory`true \| false	ex.: `false`
`IsLeadDate`true \| false	ex.: `false`
`IsLeadDateMandatory`true \| false	ex.: `false`
`LeadPhoneCountry`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir captura de leads (base)Definir campos personalizados de lead Definir rótulos de lead

PUT/api/set-lead-fields/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry=<LeadPhoneCountry>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsLeadEmailtrue / false

IsLeadEmailMandatorytrue / false

IsLeadNametrue / false

IsLeadNameMandatorytrue / false

IsLeadPhonetrue / false

IsLeadPhoneMandatorytrue / false

IsLeadCompanytrue / false

IsLeadCompanyMandatorytrue / false

IsLeadDatetrue / false

IsLeadDateMandatorytrue / false

LeadPhoneCountry

Definir campos personalizados de lead

Define campos personalizados extras no formulário de captura de leads, além dos padrões nome/e-mail/telefone.

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir campos personalizados de lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsLeadCustom1`true \| false	ex.: `false`
`IsLeadCustom1Mandatory`true \| false	ex.: `false`
`Custom1Label`	—
`IsLeadCustom2`true \| false	ex.: `false`
`IsLeadCustom2Mandatory`true \| false	ex.: `false`
`Custom2Label`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir campos de lead Definir rótulos de lead

PUT/api/set-lead-custom-fields/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=<Custom1Label>' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label=<Custom2Label>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsLeadCustom1true / false

IsLeadCustom1Mandatorytrue / false

Custom1Label

IsLeadCustom2true / false

IsLeadCustom2Mandatorytrue / false

Custom2Label

Definir rótulos de lead

Define os rótulos de exibição e o texto de placeholder dos campos do formulário de captura de leads.

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir rótulos de lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`LeadEmail`email	—
`LeadName`	—
`LeadPhone`phone	—
`LeadCompany`	—
`LeadDate`	—
`LeadButton`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir campos de lead Definir campos personalizados de lead

PUT/api/set-lead-labels/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=<LeadEmail>' \
  --data-urlencode 'LeadName=<LeadName>' \
  --data-urlencode 'LeadPhone=<LeadPhone>' \
  --data-urlencode 'LeadCompany=<LeadCompany>' \
  --data-urlencode 'LeadDate=<LeadDate>' \
  --data-urlencode 'LeadButton=<LeadButton>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

LeadEmailemail

LeadName

LeadPhonephone

LeadCompany

LeadDate

LeadButton

Definir privacidade do lead

Configura o texto e as opções de privacidade/consentimento da captura de leads (ex.: a caixa de consentimento da LGPD).

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir privacidade do lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsLeadPrivacyPolicy`true \| false	ex.: `false`
`PrivacyPolicyURL`URL	—
`PrivacyPolicyText`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir captura de leads (base)

PUT/api/set-lead-privacy/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=<PrivacyPolicyURL>' \
  --data-urlencode 'PrivacyPolicyText=<PrivacyPolicyText>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsLeadPrivacyPolicytrue / false

PrivacyPolicyURLURL

PrivacyPolicyText

Definir verificação de lead

Liga ou desliga a verificação de e-mail dos leads, exigindo que os leitores confirmem o e-mail antes de acessar.

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir verificação de lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsVerifyEmail`true \| false	ex.: `false`
`IsVerifyMobile`true \| false	ex.: `false`
`TwillioAPIKey`	Sua chave de API da Twilio (o nome do campo mantém a grafia original 'Twillio').
`EmailVerifyTitleText`	—
`EmailVerifyButtonText`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir captura de leads (base)

PUT/api/set-lead-verification/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=<TwillioAPIKey>' \
  --data-urlencode 'EmailVerifyTitleText=<EmailVerifyTitleText>' \
  --data-urlencode 'EmailVerifyButtonText=<EmailVerifyButtonText>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsVerifyEmailtrue / false

IsVerifyMobiletrue / false

TwillioAPIKeySua chave de API da Twilio (o nome do campo mantém a grafia original 'Twillio').

EmailVerifyTitleText

EmailVerifyButtonText

Definir webhook de lead

Define uma URL de webhook que recebe cada novo lead (salva como o webhook de novo lead). Use test-webhook para verificar se ele dispara.

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir webhook de lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

WebhookURL_NewLeadURL A URL do seu endpoint — recebe um payload JSON a cada novo lead.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosTestar webhook Listar leads Definir Google Sheets de leads

PUT/api/set-lead-webhook/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=<WebhookURL_NewLead>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

WebhookURL_NewLeadURLA URL do seu endpoint — recebe um payload JSON a cada novo lead.

Testar webhook

Dispara um payload de TESTE para o webhook de leads configurado no flipbook, para que você verifique o formato de entrega sem um lead real. Retorna o ERROR 'No lead webhook is configured for this flipbook.' se nenhum estiver configurado. O formato do payload corresponde a um lead real (chaves: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2), mas traz valores fictícios (pdf_id:"-1", pdf_name:"Test PDF", ...). Nenhum lead real é armazenado e nenhum e-mail de notificação é enviado.

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir webhook de lead(um webhook precisa ser configurado primeiro)→Testar webhook

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir webhook de lead

POST/api/test-webhook/{flipbookId}

curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Definir Google Sheets de leads

Conecta a captura de leads a uma Planilha Google — novos leads são adicionados à planilha que você especificar (ID + nome da planilha).

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir captura de leads (base)(ative a captura de leads)→Definir Google Sheets de leads

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`GoogleSheetURL`URL	—
`GoogleSheetIDKey`	—
`GoogleSheetName`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir webhook de lead Listar leads

PUT/api/set-lead-google-sheets/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=<GoogleSheetURL>' \
  --data-urlencode 'GoogleSheetIDKey=<GoogleSheetIDKey>' \
  --data-urlencode 'GoogleSheetName=<GoogleSheetName>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

GoogleSheetURLURL

GoogleSheetIDKey

GoogleSheetName

Seções — Notificações e modelos de e-mail

Definir notificações

Configura quais notificações por e-mail você recebe para este flipbook (novo lead, nova visualização, nova venda).

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir notificações

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`NotificationsEmail`email	—
`IsSendEmailOnView`true \| false	ex.: `false`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir modelo de e-mail — novo lead Definir modelo de e-mail — nova visualização Definir modelo de e-mail — nova venda

PUT/api/set-notifications/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-notifications/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=<NotificationsEmail>' \
  --data-urlencode 'IsSendEmailOnView=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

NotificationsEmailemail

IsSendEmailOnViewtrue / false

Definir modelo de e-mail — novo lead

Define o e-mail enviado em um evento de novo lead. Envie valores vazios para restaurar o modelo padrão NEW_LEAD.

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir modelo de e-mail — novo lead

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`EmailLeadSubject`	—
`EmailLeadBody`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir notificações Definir captura de leads (base)

PUT/api/set-email-template-lead/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=<EmailLeadSubject>' \
  --data-urlencode 'EmailLeadBody=<EmailLeadBody>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailLeadSubject

EmailLeadBody

Definir modelo de e-mail — nova visualização

Define o modelo de e-mail enviado em uma notificação de nova visualização. Envie vazio para restaurar o modelo padrão NEW_VIEW.

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir modelo de e-mail — nova visualização

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`EmailViewSubject`	—
`EmailViewBody`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir notificações

PUT/api/set-email-template-view/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=<EmailViewSubject>' \
  --data-urlencode 'EmailViewBody=<EmailViewBody>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailViewSubject

EmailViewBody

Definir modelo de e-mail — nova venda

Define o modelo de e-mail enviado em uma notificação de nova venda. Envie vazio para restaurar o modelo padrão NEW_SALE.

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir modelo de e-mail — nova venda

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`EmailSaleSubject`	—
`EmailSaleBody`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir notificações Definir configurações de venda

PUT/api/set-email-template-sale/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=<EmailSaleSubject>' \
  --data-urlencode 'EmailSaleBody=<EmailSaleBody>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailSaleSubject

EmailSaleBody

Seções — Vendas

Definir configurações de venda

Configura a venda do flipbook (preço, moeda, opções). Ativar o modo de venda ativa automaticamente a verificação de e-mail e torna o e-mail do lead obrigatório.

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Listar moedas(escolha SaleCurr)→Definir configurações de venda

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsForSale`true \| false	ex.: `false`
`SaleCurr`	De /api/list-currencies
`SaleAmount`number	ex.: `0`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosListar moedas Definir texto da página de venda Definir gateway de venda Registrar compra de flipbook

PUT/api/set-sale-settings/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=false' \
  --data-urlencode 'SaleCurr=USD' \
  --data-urlencode 'SaleAmount=0'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsForSaletrue / false

SaleCurrDe /api/list-currencies

SaleAmountnumber

Definir texto da página de venda

Define o texto de marketing exibido na página de venda / checkout do flipbook.

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir configurações de venda(ative a venda)→Definir texto da página de venda

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`SalePageTitle`	—
`SaleAccessPageTitle`	—
`SalePurchaseButtonText`	—
`SaleButtonText`	—
`SaleAccessButtonText`	—
`SaleButtonColor`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir configurações de venda Definir gateway de venda

PUT/api/set-sale-page-text/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=<SalePageTitle>' \
  --data-urlencode 'SaleAccessPageTitle=<SaleAccessPageTitle>' \
  --data-urlencode 'SalePurchaseButtonText=<SalePurchaseButtonText>' \
  --data-urlencode 'SaleButtonText=<SaleButtonText>' \
  --data-urlencode 'SaleAccessButtonText=<SaleAccessButtonText>' \
  --data-urlencode 'SaleButtonColor=<SaleButtonColor>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

SalePageTitle

SaleAccessPageTitle

SalePurchaseButtonText

SaleButtonText

SaleAccessButtonText

SaleButtonColor

Definir gateway de venda

Seleciona e configura o gateway de pagamento usado ao vender este flipbook.

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir configurações de venda(ative a venda)→Definir gateway de venda

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`SaleGatewayName`	—
`SaleGatewayKey`	—
`SaleGatewaySecret`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir configurações de venda Registrar compra de flipbook

PUT/api/set-sale-gateway/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=<SaleGatewayName>' \
  --data-urlencode 'SaleGatewayKey=<SaleGatewayKey>' \
  --data-urlencode 'SaleGatewaySecret=<SaleGatewaySecret>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

SaleGatewayName

SaleGatewayKey

SaleGatewaySecret

Seções — Aprovação

Definir botão de aprovação

Adiciona um botão de pedido de aprovação ao visualizador. Ativá-lo dispara o fluxo de pedido de aprovação.

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(DocType=document — apenas itens Document)→Definir botão de aprovação

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsApprovalButton`true \| false	ex.: `false`
`ApprovalButtonText`	—
`ApprovalButtonColor`	—
`ApprovalButtonTextColor`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir modelos de e-mail de aprovação

PUT/api/set-approval-button/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-approval-button/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=false' \
  --data-urlencode 'ApprovalButtonText=<ApprovalButtonText>' \
  --data-urlencode 'ApprovalButtonColor=<ApprovalButtonColor>' \
  --data-urlencode 'ApprovalButtonTextColor=<ApprovalButtonTextColor>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsApprovalButtontrue / false

ApprovalButtonText

ApprovalButtonColor

ApprovalButtonTextColor

Definir modelos de e-mail de aprovação

Define os modelos de e-mail usados pelo fluxo de aprovação. Valores vazios usam os padrões.

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(DocType=document — apenas itens Document)→Definir modelos de e-mail de aprovação

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`EmailApproveRequestSubject`	—
`EmailApproveRequestBody`	—
`EmailApproveRemindSubject`	—
`EmailApproveRemindBody`	—
`EmailApproveSubmitSubject`	—
`EmailApproveSubmitBody`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir botão de aprovação

PUT/api/set-approval-email-templates/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=<EmailApproveRequestSubject>' \
  --data-urlencode 'EmailApproveRequestBody=<EmailApproveRequestBody>' \
  --data-urlencode 'EmailApproveRemindSubject=<EmailApproveRemindSubject>' \
  --data-urlencode 'EmailApproveRemindBody=<EmailApproveRemindBody>' \
  --data-urlencode 'EmailApproveSubmitSubject=<EmailApproveSubmitSubject>' \
  --data-urlencode 'EmailApproveSubmitBody=<EmailApproveSubmitBody>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

EmailApproveRequestSubject

EmailApproveRequestBody

EmailApproveRemindSubject

EmailApproveRemindBody

EmailApproveSubmitSubject

EmailApproveSubmitBody

Seções — Compartilhamento

Definir compartilhamento mestre

Interruptor mestre liga/desliga para os botões de compartilhamento do visualizador.

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir compartilhamento mestre

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsShareButtonstrue | false ex.: false

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir canais de compartilhamento

PUT/api/set-share-master/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-share-master/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsShareButtonstrue / false

Definir canais de compartilhamento

Alterna cada canal social de compartilhamento (Facebook, X, LinkedIn, WhatsApp, e-mail, etc.) individualmente no menu de compartilhamento do visualizador.

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir canais de compartilhamento

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsShareFacebook`true \| false	ex.: `true`
`IsShareTwitter`true \| false	ex.: `true`
`IsShareWhatsApp`true \| false	ex.: `true`
`IsShareTelegram`true \| false	ex.: `false`
`IsShareLinkedIn`true \| false	ex.: `true`
`IsSharePinterest`true \| false	ex.: `false`
`IsShareReddit`true \| false	ex.: `false`
`IsShareTumblr`true \| false	ex.: `false`
`IsShareMessenger`true \| false	ex.: `false`
`IsShareEmail`true \| false	ex.: `true`
`IsShareLine`true \| false	ex.: `false`
`IsShareWeChat`true \| false	ex.: `false`
`IsShareInstagram`true \| false	ex.: `false`
`IsShareFlipboard`true \| false	ex.: `false`
`IsShareGeneral`true \| false	ex.: `true`

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir compartilhamento mestre

PUT/api/set-share-channels/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-share-channels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsShareFacebooktrue / false

IsShareTwittertrue / false

IsShareWhatsApptrue / false

IsShareTelegramtrue / false

IsShareLinkedIntrue / false

IsSharePinteresttrue / false

IsShareReddittrue / false

IsShareTumblrtrue / false

IsShareMessengertrue / false

IsShareEmailtrue / false

IsShareLinetrue / false

IsShareWeChattrue / false

IsShareInstagramtrue / false

IsShareFlipboardtrue / false

IsShareGeneraltrue / false

Seções — Rastreamento e IA

Definir rastreamento de analytics

Adiciona seus próprios IDs de rastreamento de analytics (ex.: Google Analytics, GTM, Facebook Pixel) ao flipbook hospedado.

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir rastreamento de analytics

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`FacebookAnalyticsCode`	—
`GoogleAnalyticsCode`	—
`GoogleTagManager`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

PUT/api/set-analytics-tracking/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=<FacebookAnalyticsCode>' \
  --data-urlencode 'GoogleAnalyticsCode=<GoogleAnalyticsCode>' \
  --data-urlencode 'GoogleTagManager=<GoogleTagManager>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

FacebookAnalyticsCode

GoogleAnalyticsCode

GoogleTagManager

Definir provedor de IA

Configura o provedor de IA usado nos recursos de IA — o nome do provedor e a chave de API dele.

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir provedor de IA

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`AIProvider`	—
`AIKey`	—

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir assistente virtual

PUT/api/set-ai-provider/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=<AIProvider>' \
  --data-urlencode 'AIKey=<AIKey>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

AIProvider

AIKey

Definir assistente virtual

Configura os ajustes base do assistente virtual no visualizador (chat/ajuda).

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir assistente virtual

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`IsVA`true \| false	ex.: `false`
`VAButtonText`	—
`VAButtonColor`	—
`VAButtonTextColor`	—
`VAText`	Prompt / instruções do assistente
`VAEmbeddings`	Blob de embeddings (string)

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir texto de status do assistente virtual Definir provedor de IA

PUT/api/set-virtual-assistant/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=<VAButtonText>' \
  --data-urlencode 'VAButtonColor=<VAButtonColor>' \
  --data-urlencode 'VAButtonTextColor=<VAButtonTextColor>' \
  --data-urlencode 'VAText=<VAText>' \
  --data-urlencode 'VAEmbeddings=<VAEmbeddings>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

IsVAtrue / false

VAButtonText

VAButtonColor

VAButtonTextColor

VATextPrompt / instruções do assistente

VAEmbeddingsBlob de embeddings (string)

Definir texto de status do assistente virtual

Define o texto de status/saudação exibido pelo assistente virtual no visualizador.

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}

Pré-requisitosQuem sou eu(uma chave de API válida)→Criar por arquivo(obtenha um flipbookId)→Definir texto de status do assistente virtual

Parâmetros de caminho

flipbookIdnumber ID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

`VAButtonStatus1`	Rótulo do status de escuta
`VAButtonStatus2`	Rótulo do status de gravação
`VAButtonStatus3`	Rótulo do status de processamento
`VAButtonStatus4`	Rótulo do status de fala

Respostas de erro

401	Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200	Item ID not found or not owned by your key`{ "Result": "ERROR", "Message": "Item not found" }`
200	Unknown or misspelled body field`{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }`

Uma chave ausente/inválida é rejeitada com HTTP 401 (uma página HTML, sem JSON). Todos os outros erros retornam HTTP 200 com { "Result": "ERROR", "Message": … } — então sempre decida pelo Result, não apenas pelo status HTTP.

RelacionadosDefinir assistente virtual

PUT/api/set-virtual-assistant-status-text/{flipbookId}

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=<VAButtonStatus1>' \
  --data-urlencode 'VAButtonStatus2=<VAButtonStatus2>' \
  --data-urlencode 'VAButtonStatus3=<VAButtonStatus3>' \
  --data-urlencode 'VAButtonStatus4=<VAButtonStatus4>'

Exemplo de resposta200 OK

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Cole sua chave de API em “Sua chave de API” no topo — depois preencha os campos abaixo e envie.

Parâmetros de caminho — obrigatórios para identificar o item

flipbookIdrequirednumberID numérico do flipbook/documento — retornado por create-by-file / create-by-url (como ID) ou por list.

Parâmetros do corpo

VAButtonStatus1Rótulo do status de escuta

VAButtonStatus2Rótulo do status de gravação

VAButtonStatus3Rótulo do status de processamento

VAButtonStatus4Rótulo do status de fala

Referência da API do FlipLink

Introdução

Autenticação

Formato da resposta e tipos de resultado

Paginação

Limites de taxa

Limites e cotas do plano

Erros

Perfil

Quem sou eu

Respostas de erro

Obter perfil

Respostas de erro

Definir perfil (parcial)

Parâmetros do corpo

Respostas de erro

Assinatura e pagamentos

Obter detalhes da assinatura

Respostas de erro

Listar pagamentos

Respostas de erro

Itens — Criar

Criar por arquivo

Corpo (multipart/form-data)

Respostas de erro

Criar por URL

Parâmetros do corpo

Respostas de erro

Itens — Ler

Obter um

Parâmetros de caminho

Respostas de erro

Buscar por URL

Parâmetros de query

Respostas de erro

Listar

Parâmetros de query

Respostas de erro

Obter URL do PDF

Parâmetros de caminho

Respostas de erro

Obter link de compartilhamento

Parâmetros de caminho

Respostas de erro

Itens — Modificar

Duplicar

Parâmetros de caminho

Parâmetros do corpo

Respostas de erro

Substituir PDF (arquivo)

Parâmetros de caminho

Corpo (multipart/form-data)

Respostas de erro

Substituir PDF (URL)

Parâmetros de caminho

Parâmetros do corpo

Respostas de erro

Salvar como modelo (alternar)

Parâmetros de caminho

Parâmetros do corpo

Respostas de erro

Atribuir a uma pasta

Parâmetros de caminho

Parâmetros do corpo

Respostas de erro

Definir capa/contracapa (arquivo)

Parâmetros de caminho

Corpo (multipart/form-data)

Respostas de erro

Definir capa/contracapa (URL)

Parâmetros de caminho

Parâmetros do corpo

Respostas de erro

Remover capa/contracapa

Parâmetros de caminho

Respostas de erro

Definir expiração / Remover expiração

Parâmetros de caminho

Parâmetros do corpo

Respostas de erro