Pular para conteúdo

Pré-requisitos

Conhecimentos Necessários

Antes de começar, você deve estar familiarizado com:

  • HTTP/REST APIs: Conceitos básicos de APIs RESTful
  • JSON: Formato de dados JavaScript Object Notation
  • Autenticação: Tokens de acesso e headers HTTP
  • Linguagem de programação: Python, JavaScript, Java, PHP ou similar

Novo em APIs?

Se você é novo em APIs REST, recomendamos:

Credenciais de Acesso

Você precisará de:

Obter Credenciais

Entre em contato com o suporte Pontotel para obter:

  • Username: Seu nome de usuário
  • Password: Sua senha
  • Ambiente: Acesso ao sandbox e/ou produção

Ferramentas Recomendadas

Cliente HTTP

Escolha uma ferramenta para testar APIs:

Recomendado para iniciantes

  • Interface visual intuitiva
  • Gerenciamento de coleções
  • Suporte a ambientes

Download Postman

Alternativa leve e moderna

  • Interface limpa
  • Suporte a GraphQL
  • Open source

Download Insomnia

Para usuários de linha de comando

Bash
# Já instalado na maioria dos sistemas Unix
curl --version

Editor de Código

Recomendamos:

  • Visual Studio Code: Editor gratuito e extensível
  • PyCharm: Para desenvolvimento Python
  • WebStorm: Para JavaScript/TypeScript

Gerenciador de Ambiente

Para gerenciar variáveis de ambiente:

Bash
pip install python-dotenv
Python
1
2
3
# .env
PONTOTEL_USERNAME=seu_usuario
PONTOTEL_PASSWORD=sua_senha
Bash
npm install dotenv
JavaScript
1
2
3
// .env
PONTOTEL_USERNAME=seu_usuario
PONTOTEL_PASSWORD=sua_senha

Bibliotecas HTTP

Python

Bash
pip install requests
Python
1
2
3
import requests

response = requests.get('https://api.example.com/')

JavaScript (Node.js)

Bash
1
2
3
npm install node-fetch
# ou
npm install axios
JavaScript
1
2
3
4
5
// Fetch
const response = await fetch('https://api.example.com/');

// Axios
const response = await axios.get('https://api.example.com/');

Java

Java
1
2
3
4
// Apache HttpClient
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;

PHP

PHP
// cURL nativo ou Guzzle
composer require guzzlehttp/guzzle

Verificar Conexão

Teste se você consegue acessar a API:

Bash
curl https://apis.pontotel.com.br/pontotel/api/v4/

Resposta esperada:

JSON
1
2
3
4
5
{
  "message": "Pontotel API v4",
  "version": "4.0.0",
  "status": "active"
}

Checklist de Pré-requisitos

Antes de prosseguir, confirme que você tem:

  • Credenciais de acesso (username/password)
  • Cliente HTTP instalado (Postman, Insomnia ou cURL)
  • Editor de código configurado
  • Biblioteca HTTP na sua linguagem de preferência
  • Gerenciador de variáveis de ambiente (opcional mas recomendado)
  • Acesso à internet e à URL da API

Próximos Passos

Com tudo pronto, vamos para a autenticação:

  1. Configurar autenticação →
  2. Fazer primeira requisição →