🎮 Playground

Permite a los usuarios interactuar con tu API

Descripción General

El playground de la API es un entorno interactivo que permite a los usuarios probar y explorar los endpoints de tu API. Los desarrolladores pueden crear peticiones API, enviarlas y ver las respuestas sin salir de la documentación.

API playground para el endpoint de crear facturas.

El playground se genera automáticamente desde tu especificación OpenAPI, por lo que cualquier actualización a tu API se refleja automáticamente en el playground. También puedes crear páginas de referencia de API manualmente después de definir una URL base y método de autenticación en tu docs.json. Recomendamos generar tu playground de API desde una especificación OpenAPI. Consulta Configuración OpenAPI para obtener más información sobre cómo crear tu documento OpenAPI.

Comenzar

Configurar autenticación

Para usar el playground, necesitas configurar tu API key. Puedes obtenerla desde tu dashboard en facture.ar.

x-api-key: tu-api-key-aqui

⚠️ Importante: Usa tu API key de testing (test_sk_) para experimentar en el playground. Nunca uses tu API key de producción (prod_sk_) para pruebas.

Explorar endpoints

Navega por los diferentes endpoints disponibles en la sección “API Endpoints” para ver todos los endpoints disponibles con sus parámetros y respuestas.Los endpoints principales incluyen:

GET /cuits - Obtener lista de CUITs
POST /invoices - Crear facturas
GET /invoices/ - Obtener factura por ID
GET /invoices/search - Buscar facturas

Probar peticiones

Usa el playground interactivo para:

Modificar parámetros de petición
Enviar peticiones reales a la API
Ver respuestas en tiempo real
Copiar código de ejemplo en diferentes lenguajes

Características del Playground

🔧 Interfaz Interactiva

Editor de parámetros: Modifica fácilmente los parámetros de petición
Vista previa de petición: Ve exactamente qué se enviará a la API
Respuestas en tiempo real: Obtén respuestas inmediatas de la API
Historial de peticiones: Mantén un registro de tus pruebas

📝 Ejemplos de Código

El playground genera automáticamente ejemplos de código en múltiples lenguajes:

cURL: Para pruebas rápidas desde terminal
JavaScript: Para integración en aplicaciones web
Python: Para scripts y aplicaciones backend
PHP: Para aplicaciones PHP

🔐 Autenticación Segura

API Key Management: Configura y gestiona tu API key de forma segura
Ambientes separados: Diferencia entre testing y producción
Validación automática: El playground valida tu API key antes de enviar peticiones

Configuración Avanzada

Personalización del Playground

Puedes personalizar tu playground de API definiendo las siguientes propiedades en tu docs.json:

object

Configuraciones para el playground de la API.

Show playground

"interactive" | "simple" | "none"

El modo de visualización del playground de la API.

"interactive": Muestra el playground interactivo.
"simple": Muestra un endpoint copiable sin playground.
"none": No muestra nada.

Por defecto es interactive.

boolean

Si pasar las peticiones de API a través de un servidor proxy. Por defecto es true.

object

Configuraciones para los ejemplos de API autogenerados.

Show examples

array of string

Lenguajes de ejemplo para los snippets de API autogenerados.Los lenguajes se muestran en el orden especificado.

"required" | "all"

Si mostrar parámetros opcionales en los ejemplos de API. Por defecto es all.

Ejemplo de configuración

{
  "api": {
    "playground": {
      "display": "interactive"
    },
    "examples": {
      "languages": ["curl", "python", "javascript"],
      "defaults": "required"
    }
  }
}

Este ejemplo configura el playground de API para ser interactivo con snippets de código de ejemplo para cURL, Python y JavaScript. Solo se muestran los parámetros requeridos en los snippets de código.

Mejores Prácticas

🧪 Testing

Usa el ambiente de testing: Siempre prueba con tu API key de testing (test_sk_)
Valida respuestas: Revisa las respuestas para entender la estructura de datos
Prueba casos edge: Experimenta con diferentes valores de parámetros

🔒 Seguridad

Nunca compartas tu API key: Mantén tu API key privada y segura
Usa HTTPS: Todas las peticiones se envían a través de HTTPS
Rota tus keys: Regenera tu API key periódicamente

📚 Documentación

Lee los ejemplos: Los ejemplos de código te ayudan a entender la implementación
Consulta los esquemas: Revisa los esquemas de respuesta para entender la estructura
Usa los filtros: Aprovecha los filtros de búsqueda para encontrar endpoints específicos

Soporte

Si necesitas ayuda con el playground:

📧 Email: support@facture.ar
💬 Chat: Disponible en la plataforma
📚 Documentación: Explora nuestros ejemplos detallados
🎥 Videollamada: Para asistencia personalizada

💡 Tip: El playground es la forma más rápida de probar la API y entender cómo funciona. ¡Úsalo para experimentar antes de implementar en tu aplicación!

​🎮 Playground

​Descripción General

​Comenzar

​Características del Playground

​🔧 Interfaz Interactiva

​📝 Ejemplos de Código

​🔐 Autenticación Segura

​Configuración Avanzada

​Personalización del Playground

​Ejemplo de configuración

​Mejores Prácticas

​🧪 Testing

​🔒 Seguridad

​📚 Documentación

​Soporte

🎮 Playground

Descripción General

Comenzar

Características del Playground

🔧 Interfaz Interactiva

📝 Ejemplos de Código

🔐 Autenticación Segura

Configuración Avanzada

Personalización del Playground

Ejemplo de configuración

Mejores Prácticas

🧪 Testing

🔒 Seguridad

📚 Documentación

Soporte