Autenticação na API do FlipLink

Primeiros passos

Toda requisição à API do FlipLink é autenticada com sua chave de API. Envie-a como cabeçalho X-Api-Key ou como token Bearer e confirme a qual conta ela pertence com o Who Am I.

APIs usadas nesta discussão

Algo impreciso ou desatualizado neste guia?

O que você pode fazer

Toda chamada à API do FlipLink está vinculada a uma conta por meio da sua chave de API. Este guia mostra como enviar essa chave em uma requisição e como confirmar a qual conta uma chave pertence.

A URL base

Todas as requisições da API vão para:

https://go.fliplink.me

Enviando sua chave de API

Você pode autenticar uma requisição de duas formas — ambas são aceitas:

  • Cabeçalho X-Api-Key:
curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'X-Api-Key: YOUR_API_KEY'
  • Cabeçalho Authorization: Bearer:
curl -X GET 'https://go.fliplink.me/api/whoami' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Use a opção que combinar com o seu cliente HTTP. O restante destes guias usa X-Api-Key por consistência.

Confirme a qual conta uma chave pertence

GET /api/whoami retorna a conta dona da chave — útil para verificar se uma chave funciona e ver o tamanho máximo de upload do seu plano.

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

Resposta:

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

MaxFileSizeMB é o tamanho máximo de upload do seu plano, em megabytes.

Quando a autenticação falha

Se a chave estiver ausente ou inválida, a API responde com HTTP 401 e retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se sua chave está correta e é enviada em um dos dois cabeçalhos acima.

Mantenha sua chave em sigilo

Sua chave de API identifica sua conta — envie-a apenas a partir de código do lado do servidor. Nunca a insira em código do lado do cliente ou do navegador, onde visitantes poderiam lê-la.

Discussões relacionadas