Test within the documentation
Fill in parameters, run the request, and check the response without building a separate client for the first validation.
OmniSmart Feature · Interactive API documentation
An API your team can consult, test, and integrate
The documentation lives inside the platform, organizes endpoints by purpose, and lets you run requests with the user's token. Code examples and a Postman collection shorten the path from discovery to first integration.
Test endpoints in the browserExamples in three languagesExportable Postman collection
apiOmniSmart APIINTERACTIVE DOCUMENTATION
PTENdark_mode
GET
/v1/reports/telephony/teamslockBearer token
Team report — telephony
Returns consolidated and analytical data for teams in the specified period.
Parameters
start_datestring · required
end_datestring · required
deployed_codeExport to Postman
cURLTypeScriptPython200 OK
curl --request GET \ --url 'https://api.omnismart.com.br/v1/reports/telephony/teams' \ --header 'Authorization: Bearer ••••••••'
33 endpoints18 reports and 15 controllers documented
3 formatscURL, TypeScript, and Python
2 languagesPortuguese and English in the interface
1 clickExport collection to Postman
Developer experience
Useful documentation answers what to call, how to authenticate, and what to expect.
Instead of a loose list of routes, the documentation presents parameters, examples, pagination, responses, and errors in the context of each endpoint. The technical team can validate a call before writing the final integration.
Contextual authentication
The authenticated user's token can be used in the testing experience, respecting available access and scope.
Ready-made examples
Copy equivalent examples in cURL, TypeScript, and Python to speed up prototypes and implementation.
Export to Postman
Generate a collection with endpoints and initial structure to continue testing in your team's environment.
Reports and controllers
Browse data queries and available operations, with grouping and purpose descriptions.
Bilingual interface
View the experience in Portuguese or English, including descriptions and navigation elements.
From discovery to prototype
Find the endpoint, validate the call, and take the example to your project
The documentation reduces exploratory work, but integration still requires business rules, security, limits, and error handling.
Define the use case
Specify the data or action needed and who will be able to use the integration.
Locate the endpoint
Browse the appropriate category and review method, parameters, response, and pagination.
Run a test
Use controlled data to validate authentication, format, and expected behavior.
Copy or export
Take the example in your chosen language or generate a collection for Postman.
Implement with governance
Add secure storage, logs, limits, retries, and exception handling.
Impact on operations
What changes in practice
Integration moves forward with fewer attempts when documentation, execution, and examples use the same technical reference.
Faster first call
The team confirms authentication, parameters, and response before building the entire integration layer.
More objective diagnostics
A reproducible execution helps separate access, payload, rule, or implementation errors.
Less manual translation
Examples in common languages bring documentation closer to the code that will be produced.
Team alignment
Product, operations, and development can point to the same endpoint and the same expected response.
Who it makes sense for
A technical experience for those who need to connect systems
Developers and architectsIntegration teamsProduct and operationsTechnology partnersCustomers with ERP or CRMData and BI teams
Frequently asked questions
Learn more
It's documentation where users can view endpoint details and also fill in parameters and run a test request right in the environment.
The documented experience offers examples in cURL, TypeScript, and Python for the available endpoints.
Yes. The documentation lets you generate a collection to continue exploring and testing in Postman.
The documentation brings together report and controller endpoints as available on the platform, including queries related to calls and teams.
No. It speeds up discovery and prototyping, but a production integration still requires architecture, security, error handling, and process knowledge.
Talk to OmniSmart
Show what your systems need to exchange with OmniSmart
Map data, events, actions, and responsibilities to identify the right endpoints and integration design.
Chat with a specialist
Tell us the basics about your scenario.