Skip to content

Referencia de API

Documentación completa de API para la API REST de Visiono.

Documentación de API

📚 Documentación Completa de API

Documentación interactiva de API con ejemplos, esquemas de solicitud/respuesta y herramientas de prueba.

Abrir Documentación de API →

Enlaces Rápidos

RecursoDescripción
Documentación de APIReferencia interactiva completa de API
Claves de APICrear y gestionar claves de API
WebhooksConfigurar notificaciones de eventos

Resumen de API

URL Base

https://api.visio.now/v1

Autenticación

Todas las solicitudes API requieren autenticación vía clave de API:

bash
curl -X GET "https://api.visio.now/v1/status" \
  -H "X-API-Key: tu-clave-api"

Formato de Respuesta

Todas las respuestas son JSON:

json
{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

Endpoints Disponibles

Solicitudes de Fotos

MétodoEndpointDescripción
GET/photo-requestsListar todas las solicitudes de fotos
POST/photo-requestsCrear una nueva solicitud de fotos *
GET/photo-requests/{id}Obtener una solicitud específica
DELETE/photo-requests/{id}Eliminar una solicitud

* Los usuarios del plan gratuito no pueden usar los parámetros recipient_email o send_email. Ver limitaciones del plan gratuito.

Estadísticas

MétodoEndpointDescripción
GET/statsObtener estadísticas de uso e info del plan

Enlaces Permanentes

MétodoEndpointDescripción
GET/permanent-linksListar todos los Enlaces Permanentes
POST/permanent-linksCrear un nuevo Enlace Permanente
GET/permanent-links/{id}Obtener un Enlace Permanente específico
PATCH/permanent-links/{id}Actualizar un Enlace Permanente
DELETE/permanent-links/{id}Eliminar un Enlace Permanente

Estado

MétodoEndpointDescripción
GET/statusVerificación de salud de API

Respuestas de Error

Formato de Error

json
{
  "error": {
    "code": "validation_error",
    "message": "Los datos proporcionados no son válidos.",
    "details": {
      "instructions": ["El campo de instrucciones es requerido."]
    }
  }
}

Códigos de Estado Comunes

CódigoDescripción
200Éxito
201Creado
400Solicitud Incorrecta
401No Autorizado
403Prohibido
404No Encontrado
422Error de Validación
429Límite de Tasa Excedido
500Error del Servidor

Límites de Tasa

LímiteValor
Solicitudes por minuto60
Solicitudes por hora1,000

Cabeceras de límite de tasa:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200

SDKs y Bibliotecas

Actualmente, la API está basada en REST. SDKs oficiales próximamente.

Herramientas de la Comunidad

Para automatización, considera:

Limitaciones Plan Gratuito

El Plan Developer Free tiene restricciones específicas de API:

Parámetros de Correo Prohibidos

Los usuarios del plan gratuito reciben errores 422 al usar:

  • recipient_email - Parámetro de dirección de correo
  • send_email - Indicador booleano para enviar correos

Respuesta de Error API:

json
{
  "message": "The recipient email field is prohibited.",
  "errors": {
    "recipient_email": [
      "Email features are not available on the free plan. Upgrade to send photo requests via email."
    ]
  }
}

Alternativa: Usa la request_url de respuestas exitosas para compartir enlaces por otros canales (SMS, chat, etc.).

Diferencias en Respuesta Stats

Las respuestas GET /stats del plan gratuito incluyen:

  • plan.email_enabled: false
  • usage.is_lifetime_quota: true (100 fotos en total, no mensuales)
  • usage.billing_period_start: null
  • usage.billing_period_end: null

Ver documentación detallada del plan gratuito

Soporte

¿Necesitas ayuda con la API?

Páginas Relacionadas

Plataforma Profesional de Documentación Fotográfica