Skip to content

Référence API

Documentation complète de l'API REST Visiono.

Documentation API

📚 Documentation API complète

Documentation API interactive avec exemples, schémas de requête/réponse et outils de test.

Ouvrir la documentation API →

Liens rapides

RessourceDescription
Documentation APIRéférence API interactive complète
Clés APICréer et gérer les clés API
WebhooksConfigurer les notifications d'événements

Aperçu de l'API

URL de base

https://api.visio.now/v1

Authentification

Toutes les requêtes API nécessitent une authentification via clé API :

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

Format des réponses

Toutes les réponses sont en JSON :

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

Points de terminaison disponibles

Demandes de photos

MéthodePoint de terminaisonDescription
GET/photo-requestsLister toutes les demandes de photos
POST/photo-requestsCréer une nouvelle demande de photos *
GET/photo-requests/{id}Obtenir une demande spécifique
DELETE/photo-requests/{id}Supprimer une demande

* Les utilisateurs du forfait gratuit ne peuvent pas utiliser les paramètres recipient_email ou send_email. Voir limitations du forfait gratuit.

Statistiques

MéthodePoint de terminaisonDescription
GET/statsObtenir statistiques d'utilisation et info forfait

Liens permanents

MéthodePoint de terminaisonDescription
GET/permanent-linksLister tous les liens permanents
POST/permanent-linksCréer un nouveau lien permanent
GET/permanent-links/{id}Obtenir un lien permanent spécifique
PATCH/permanent-links/{id}Mettre à jour un lien permanent
DELETE/permanent-links/{id}Supprimer un lien permanent

Statut

MéthodePoint de terminaisonDescription
GET/statusVérification de santé de l'API

Réponses d'erreur

Format d'erreur

json
{
  "error": {
    "code": "validation_error",
    "message": "Les données fournies sont invalides.",
    "details": {
      "instructions": ["Le champ instructions est requis."]
    }
  }
}

Codes de statut courants

CodeDescription
200Succès
201Créé
400Requête invalide
401Non autorisé
403Interdit
404Non trouvé
422Erreur de validation
429Limite de débit atteinte
500Erreur serveur

Limites de débit

LimiteValeur
Requêtes par minute60
Requêtes par heure1 000

En-têtes de limite de débit :

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

SDKs et bibliothèques

Actuellement, l'API est basée sur REST. SDKs officiels à venir.

Outils communautaires

Pour l'automatisation, considérez :

Limitations forfait gratuit

Le forfait Developer Free a des restrictions API spécifiques :

Paramètres e-mail interdits

Les utilisateurs du forfait gratuit reçoivent des erreurs 422 lors de l'utilisation de :

  • recipient_email - Paramètre d'adresse e-mail
  • send_email - Indicateur booléen pour envoyer des e-mails

Réponse d'erreur 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."
    ]
  }
}

Alternative : Utilisez la request_url des réponses réussies pour partager des liens via d'autres canaux (SMS, chat, etc.).

Différences dans la réponse Stats

Les réponses GET /stats du forfait gratuit incluent :

  • plan.email_enabled: false
  • usage.is_lifetime_quota: true (100 photos au total, non mensuelles)
  • usage.billing_period_start: null
  • usage.billing_period_end: null

Voir documentation détaillée du forfait gratuit

Support

Besoin d'aide avec l'API ?

Pages connexes

Plateforme Professionnelle de Documentation Photo