API Développeur

Appelez les outils depuis vos propres logiciels sans passer par un navigateur : envoyez une requête, lancez une tâche et téléchargez le résultat. Tous les points de terminaison sont réunis sous une adresse unique et versionnée ; chaque requête est autorisée par une clé personnelle.

Déroulement d'une tâche

Un seul appel démarre une tâche de conversion et fournit son identifiant. Cet identifiant vous permet de suivre l'avancement et de télécharger le fichier produit une fois le traitement terminé. Les tâches pouvant demander du temps, cette dissociation permet aux clients d'attendre sans bloquer leur exécution.

Clé et accès

Les requêtes sont signées avec l'en-tête Authorization: Bearer. Créez votre clé depuis votre compte et révoquez-la à tout moment ; la clé brute n'est visible qu'à sa création. Une session de navigateur ne constitue pas une méthode d'authentification ici.

Outils disposant d'une API ouverte

Gestion des versions et contrat

Les points de terminaison sont versionnés sous https://api.pixepi.com avec /api/v1 ; toute rupture de compatibilité ascendante entraîne une nouvelle version. Le contrat exploitable par machine est mis à disposition au format OpenAPI 3.1 et s'intègre directement dans les générateurs de clients.

Réponses et erreurs

Les réponses sont encapsulées en JSON ; chaque tâche est interrogée via son identifiant propre et l'appartenance de l'enregistrement est contrôlée côté serveur. En cas d'anomalie, la réponse renvoie un code décrivant la situation, que le client peut interpréter selon ses besoins.

Pour aller plus loin

• Le lien API affiché sur la page de l'outil sélectionné permet d'accéder à ses points de terminaison, ses paramètres de requête, ses options et ses codes d'erreur.
• Contrat exploitable par machine : document OpenAPI.
• Portail développeur central : liste commune de tous les points de terminaison.