Documentación API

Documentación OpenAPI

La documentación completa de la API de Raisetalk está disponible en formato OpenAPI en la siguiente dirección: https://api.raisetalk.com/docs.

Se genera automáticamente a partir del código fuente de la API y se actualiza en cada despliegue, lo que garantiza que siempre refleje fielmente el comportamiento real de los endpoints expuestos.

El archivo de especificación en bruto también está accesible en https://api.raisetalk.com/openapi.yaml.

Generar un SDK

A partir de esta especificación OpenAPI, es fácil generar un SDK cliente en prácticamente cualquier lenguaje (PHP, Python, TypeScript, Java, Go, Ruby, C#, etc.) mediante la herramienta openapi-generator-cli.

Ejemplo para generar un SDK PHP:

docker run --rm \
  -v "${PWD}:/local" \
  openapitools/openapi-generator-cli generate \
  -i https://api.raisetalk.com/openapi.yaml \
  -g php \
  -o /local/sdk/php

Para cambiar el lenguaje de destino, basta con modificar el valor del parámetro -g (por ejemplo -g python, -g typescript-axios, -g java, etc.).

La lista completa de generadores disponibles y la documentación detallada de la herramienta están disponibles en el sitio oficial: https://openapi-generator.tech/.