Prerequisites¶

Required Knowledge¶

Before you begin, you should be familiar with:

• HTTP/REST APIs: Basic concepts of RESTful APIs
• JSON: JavaScript Object Notation data format
• Authentication: Access tokens and HTTP headers
• Programming language: Python, JavaScript, Java, PHP or similar

Access Credentials¶

You will need:

Recommended Tools¶

HTTP Client¶

Choose a tool to test APIs:

1
2

# Already installed on most Unix systems
curl --version

Code Editor¶

We recommend:

• Visual Studio Code: Free and extensible editor
• PyCharm: For Python development
• WebStorm: For JavaScript/TypeScript

Environment Manager¶

To manage environment variables:

1

pip install python-dotenv

1
2
3

# .env
PONTOTEL_USERNAME=your_username
PONTOTEL_PASSWORD=your_password

1

npm install dotenv

1
2
3

// .env
PONTOTEL_USERNAME=your_username
PONTOTEL_PASSWORD=your_password

HTTP Libraries¶

Python¶

1

pip install requests

1
2
3

import requests

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

JavaScript (Node.js)¶

1
2
3

npm install node-fetch
# or
npm install axios

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¶

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¶

1
2

// Native cURL or Guzzle
composer require guzzlehttp/guzzle

Verify Connection¶

Test if you can access the API:

1

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

Expected response:

1
2
3
4
5

{
  "message": "Pontotel API v4",
  "version": "4.0.0",
  "status": "active"
}

Prerequisites Checklist¶

Before proceeding, confirm you have:

• Access credentials (username/password)
• HTTP client installed (Postman, Insomnia or cURL)
• Code editor configured
• HTTP library in your preferred language
• Environment variable manager (optional but recommended)
• Internet access and API URL access

Next Steps¶

With everything ready, let's move to authentication:

1. Configure authentication →
2. Make first request →