API Architecture¶

REST Principles¶

The Pontotel API follows the principles REST (Representational State Transfer):

• Resources: Entities like users, employees, scales
• HTTP Methods: GET, POST, PUT, PATCH, DELETE
• JSO N: Data format for requests and replies
• Status Codes: Standard HTTP codes (200, 201, 400, 404, etc.)
• Stateless: Each request is independent

Base URL¶

==="Production"

1

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

===Sandbox===

1

https://sandbox-apis.pontotel.com.br/pontotel/api/v4/

HTTP Methods¶

Default Response Format¶

List (Get collection)¶

All listing answers follow the paginated format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "count": 150,
  "next": "https://apis.pontotel.com.br/pontotel/api/v4/usuarios/?page=2",
  "previous": null,
  "results": [
    {
      "id": 1,
      "username": "usuario1",
      "email": "usuario1@example.com"
    }
  ]
}

Individual Object (Get detail)¶

1
2
3
4
5
6
7
8

{
  "id": 1,
  "username": "usuario1",
  "email": "usuario1@example.com",
  "first_name": "João",
  "last_name": "Silva",
  "is_active": true
}

Error¶

1
2
3
4
5
6
7

{
  "error": "validation_error",
  "message": "Dados inválidos na requisição",
  "details": {
    "email": ["Este campo é obrigatório."]
  }
}

Status Codes¶

Authentication¶

All requests (except /login/) require the header:

1
2

Authorization: Bearer {seu_access_token}
Content-Type: application/json

See the full tab on Authentication →

Main areas¶

Next Steps¶

• Know the environments →
• Understanding fundamental concepts →
• Start integration →