Aller au contenu principal

API

CLIENTXCMS met à disposition une API RESTful pour permettre aux développeurs de créer des applications qui interagissent avec les données de CLIENTXCMS. Cette API est basée sur les standards RESTful et utilise des codes d'état HTTP pour indiquer les erreurs. Les réponses peuvent être retournées en JSON ou en XML selon l'entête demandé.

image

Authentification​

Pour utiliser l'API, vous devez fournir une clé d'API dans l'en-tête de chaque requête. Vous pouvez obtenir une clé d'API avec la commande suivante :

php artisan clientxcms:create-api-key {name} {email} {--permissions=*}

Le premier argument est le nom de la clé d'API, le second est le compte administrateur associé à la clé d'API, et le troisième est la liste des permissions de la clé d'API.

Exemple​

PHP​

<?php
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://clientxcms.app/api/application/products', [
    'headers' => [
        'Authorization' => 'Bearer YOUR TOKEN HERE',
        'Accept' => 'application/json'
    ]
]);
$json = json_decode($response->getBody()->getContents());

Node.js​

const axios = require('axios');
axios.get('https://clientxcms.app/api/application/products', {
    headers: {
        'Authorization': 'Bearer YOUR TOKEN HERE',
        'Accept': 'application/json'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});
info

N'hésitez pas à utiliser ?pricing=1 pour obtenir les prix des produits en plus des produits.

Permissions​

Les permissions suivantes sont disponibles pour les clés d'API :

  • * : Toutes les permissions
  • health : Vérifier l'état de santé de l'API
  • statitics : Obtenir les statistiques de l'API
  • license : Obtenir les informations de la licence

Nous sommes en train de travailler sur de nouvelles permissions pour les clés d'API afin de rajouter plus de flexibilité et l'accès à plus de ressources. Une mise à jour est prévue pour améliorer l'API.

Spécifications​

Vous pouvez consulter la documentation de l'API pour obtenir des informations sur les différentes ressources et les opérations disponibles. Vous pouvez également tester l'API en utilisant l'interface Swagger fournie sur l'URL /api/documentation sur votre espace client.