Prueba dentro de la documentación
Completa los parámetros, ejecuta la solicitud y consulta la respuesta sin crear un cliente separado para la primera validación.
Funcionalidad OmniSmart · Documentación interactiva de la API
Una API que tu equipo puede consultar, probar y integrar
La documentación está dentro de la plataforma, organiza los endpoints por finalidad y permite ejecutar solicitudes con el token del usuario. Los ejemplos de código y la colección de Postman reducen el camino entre el descubrimiento y la primera integración.
Prueba de endpoints en el navegadorEjemplos en tres lenguajesColección Postman exportable
apiOmniSmart APIDOCUMENTACIÓN INTERACTIVA
PTENdark_mode
GET
/v1/reports/telephony/teamslockBearer token
Informe de equipos — telefonía
Devuelve datos consolidados y analíticos de los equipos en el período informado.
Parámetros
start_datestring · requerido
end_datestring · requerido
deployed_codeExportar Postman
cURLTypeScriptPython200 OK
curl --request GET \ --url 'https://api.omnismart.com.br/v1/reports/telephony/teams' \ --header 'Authorization: Bearer ••••••••'
33 endpoints18 informes y 15 controladores documentados
3 formatoscURL, TypeScript y Python
2 idiomasPortugués y inglés en la interfaz
1 clicExportación de colección para Postman
Experiencia para desarrolladores
Una documentación útil responde qué llamar, cómo autenticarse y qué esperar.
En lugar de una lista suelta de rutas, la documentación presenta parámetros, ejemplos, paginación, respuestas y errores en el contexto de cada endpoint. El equipo técnico puede validar una llamada antes de escribir la integración definitiva.
Autenticación contextual
El token del usuario autenticado se puede utilizar en la experiencia de prueba, respetando el acceso y el alcance disponibles.
Ejemplos listos
Copia ejemplos equivalentes en cURL, TypeScript y Python para acelerar prototipos y implementación.
Exportación para Postman
Genera una colección con endpoints y estructura inicial para continuar las pruebas en el entorno del equipo.
Informes y controladores
Navega entre consultas de datos y operaciones disponibles, con agrupación y descripción de finalidad.
Interfaz bilingüe
Consulta la experiencia en portugués o inglés, incluyendo descripciones y elementos de navegación.
Del descubrimiento al prototipo
Encuentra el endpoint, valida la llamada y lleva el ejemplo al proyecto
La documentación reduce el trabajo exploratorio, pero la integración sigue exigiendo reglas de negocio, seguridad, límites y manejo de fallas.
Define el caso de uso
Especifica el dato o la acción necesaria y quién podrá utilizar la integración.
Localiza el endpoint
Navega por la categoría adecuada y revisa método, parámetros, respuesta y paginación.
Ejecuta una prueba
Usa datos controlados para validar autenticación, formato y comportamiento esperado.
Copie o exporte
Lleve el ejemplo del lenguaje elegido o genere una colección para Postman.
Implemente con gobernanza
Agregue almacenamiento seguro, registros, límites, reintentos y manejo de excepciones.
Impacto en la operación
Qué cambia en la práctica
La integración avanza con menos fricción cuando la documentación, la ejecución y los ejemplos usan la misma referencia técnica.
Primera llamada más rápida
El equipo confirma autenticación, parámetros y respuesta antes de construir toda la capa de integración.
Diagnóstico más objetivo
Una ejecución reproducible ayuda a separar errores de acceso, payload, regla o implementación.
Menos traducción manual
Los ejemplos en lenguajes habituales acercan la documentación al código que se producirá.
Alineación entre equipos
Producto, operación y desarrollo pueden apuntar al mismo endpoint y a la misma respuesta esperada.
Para quién tiene sentido
Una experiencia técnica para quienes necesitan conectar sistemas
Desarrolladores y arquitectosEquipos de integraciónProducto y operacionesSocios tecnológicosClientes con ERP o CRMEquipos de datos y BI
Preguntas frecuentes
Entienda mejor
Es una documentación en la que el usuario consulta detalles del endpoint y también puede completar parámetros y ejecutar una solicitud de prueba en el propio entorno.
La experiencia documentada ofrece ejemplos en cURL, TypeScript y Python para los endpoints disponibles.
Sí. La documentación permite generar una colección para continuar la exploración y las pruebas en Postman.
La documentación reúne endpoints de informes y controladores según la disponibilidad de la plataforma, incluyendo consultas relacionadas con llamadas y equipos.
No. Acelera el descubrimiento y la creación de prototipos, pero una integración de producción aún requiere arquitectura, seguridad, manejo de fallas y conocimiento del proceso.
Hable con OmniSmart
Muestre lo que sus sistemas necesitan intercambiar con OmniSmart
Mapee datos, eventos, acciones y responsabilidades para identificar los endpoints y el diseño de integración adecuados.
Converse con un especialista
Cuente lo básico sobre su escenario.