API Reference¶

Interactive Documentation¶

Explore the full and interactive API documentation Pontotel using our Swagger UI interface.

OpenAPI specification¶

The full OpenAPI specification is available at:

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

Interactive Interface¶

How to Use Try It Out¶

1. Get it first.¶

Before testing any endpoint:

1. Go to the section Authentication
2. Expand the endpoint POST /login/
3. Click Try it out
4. Fill in your credentials
5. Click "Execute"
6. Copy access_token response

2. Authorize interface¶

1. Click the button "Authorize" at the top of the page (lock icon)
2. In the field Value, paste the token in the format:

   Text Only
   1	Bearer your_token_here

3. Click "Authorize"
4. Click "Close"

3. Test endpoints¶

Now you can test any endpoint:

1. Navigate to desired endpoint
2. Click Try it out
3. Fill in the necessary parameters
4. Click "Execute"
5. See the full answer below

Fast Navigation by Category¶

Authentication¶

• POST /login/ - Log in and get token

Users¶

• GET /usuarios/ - List users
• POST /usuarios/ - Create user
• GET /usuarios/{id}/ - Get specific user
• PUT /usuarios/{id}/ - Update user
• DELETE /usuarios/{id}/ - Delete user

Employees¶

• GET /empregados/ - List employees
• POST /empregados/ - Create employee
• GET /empregados/{id}/ - Get specific employee
• PUT /empregados/{id}/ - Update employee
• DELETE /empregados/{id}/ - Delete employee

Employers¶

• GET /empregadores/ - Listing employers
• POST /empregadores/ - Create an employer
• GET /empregadores/{id}/ - Get specific employer

Workplaces¶

• GET /locais-trabalho/ - List locations
• POST /locais-trabalho/ - Create local

Scales and Journeys¶

• GET /escalas/ - List scales
• POST /escalas/ - Create scale

Vacation¶

• GET /ferias/ - List vacation periods
• POST /ferias/ - Registration holiday

Absences¶

• GET /afastamentos/ - List removals
• POST /afastamentos/ - Registration removal

Download Specification¶

You can download OpenAPI specification for use in other tools:

• Download JSON
• YAML Download

Compatible Tools¶

Import specification on:

• Postman - Automated collections and tests
• Insomnia - REST Client
• Swagger Editor - Online Editor
• OpenAPI Generator - SDK Generation
• Stoplight - Design and documentation

API Versions¶

Next Steps¶

• Understand Authentication →
• Explore entities →
• See examples of code →
• Know good practice →