Iniciando com a REST API da Goalfy

Essa página vai trazer algumas informações de como iniciar a utilização da nossa API!


📕 Introdução

Bem-vindo à API da Goalfy.

Esta documentação descreve os recursos disponíveis para integração com a plataforma Goalfy,
permitindo que sistemas externos realizem operações de forma segura, estruturada e escalável.

A API segue os princípios REST, utiliza JSON como formato padrão de comunicação
e opera exclusivamente sobre HTTPS.


⚙ Autenticação

Todas as requisições aos endpoints da API da Goalfy exigem autenticação via
Token [SEU_TOKEN] utilizando o padrão Bearer Token.

O token deve ser enviado no header Authorization em todas as requisições.
Requisições com autenticação inválida retornarão 401 - Unauthorized.

Formato do Header:

Authorization: Token SEU_TOKEN_AQUI


🔐 Como gerar um Token

  1. Acesse:

    https://app.goalfy.com.br/settings/0

  2. Role até o final da página
  3. Clique em "Gerar Chave"
  4. Copie o token gerado
  5. Armazene-o em local seguro

Importante: O token concede acesso aos dados da sua conta. Não compartilhe essa chave publicamente.


🚀 Como utilizar o Token

Inclua o token no header Authorization ao realizar qualquer requisição HTTP.

curl -X GET

Certifique-se de que:

  • A requisição esteja sendo feita via HTTPS
  • O token esteja válido
  • O header esteja corretamente formatado