Documentation API

Intégrez le puissant moteur de tarification de Grula dans vos applications avec notre API REST complète. Calculez les prix, gérez les politiques tarifaires et configurez les ajustements dynamiques par programmation.

Démarrage rapide

Commencez avec l'API Grula en quelques minutes. Tout ce dont vous avez besoin est un token API pour commencer à faire des requêtes.

Authentification

Toutes les requêtes API nécessitent une authentification avec un token Bearer. Vous pouvez générer votre token API depuis le tableau de bord Grula.

Authorization: Bearer YOUR_API_TOKEN

Base URL

https://api.grula.net

Concepts clés

Politiques de tarification (Grilles tarifaires)

Les politiques de tarification définissent vos prix de base pour les produits ou services. Pensez-y comme vos grilles tarifaires qui contiennent les règles de tarification fondamentales pour votre entreprise.

Politiques d'ajustement des prix (Remises et frais)

Les politiques d'ajustement des prix modifient vos prix de base en appliquant des remises, des frais ou d'autres ajustements basés sur des conditions spécifiques comme le type de client, le volume ou les facteurs saisonniers.

Get PricePOST

Calculez un prix unique basé sur les facteurs de prix, la devise et la date de tarification optionnelle. C'est l'endpoint principal pour les calculs de prix en temps réel.

Endpoint

POST /api/v1/price
curl -X POST "https://api.grula.net/api/v1/price" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "priceDrivers": [
      {
        "name": "product",
        "value": "laptop"
      },
      {
        "name": "customer_tier",
        "value": "premium"
      }
    ],
    "currencyThreeLetterCode": "USD",
    "pricingDate": "2024-01-15T10:00:00Z"
  }'

Get Multiple PricesPOST

Calculez plusieurs prix en une seule requête. Efficace pour les opérations de tarification en masse avec un maximum de 100 requêtes de prix par appel.

Endpoint

POST /api/v1/prices
curl -X POST "https://api.grula.net/api/v1/prices" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "priceRequests": [
      {
        "priceDrivers": [
          {"name": "product", "value": "laptop"},
          {"name": "customer_tier", "value": "premium"}
        ],
        "currencyThreeLetterCode": "USD",
        "pricingDate": "2024-01-15T10:00:00Z"
      },
      {
        "priceDrivers": [
          {"name": "product", "value": "desktop"},
          {"name": "customer_tier", "value": "standard"}
        ],
        "currencyThreeLetterCode": "EUR",
        "pricingDate": "2024-01-15T10:00:00Z"
      }
    ]
  }'

Exemples de réponse

Comprendre la structure des réponses API vous aide à intégrer efficacement les données de tarification dans vos applications.

Price Response

{
  "amount": {
    "amount": 1299.99,
    "currencyThreeLetterCode": "USD"
  },
  "priceComponents": [
    {
      "pricingPolicyId": "123e4567-e89b-12d3-a456-426614174000",
      "amount": {
        "amount": 1499.99,
        "currencyThreeLetterCode": "USD"
      }
    },
    {
      "priceAdjustmentPolicyId": "456e7890-e89b-12d3-a456-426614174001",
      "amount": {
        "amount": -200.00,
        "currencyThreeLetterCode": "USD"
      },
      "priceAdjustmentPolicyActionName": "Premium Customer Discount",
      "priceAdjustmentPolicyValue": 0.15
    }
  ]
}

Gestion des erreurs

L'API utilise des codes de statut HTTP standard pour indiquer le succès ou l'échec des requêtes. Voici les codes de statut les plus courants que vous rencontrerez.

Codes de statut HTTP

200
Success - Requête terminée avec succès
201
Created - Ressource créée avec succès
400
Bad Request - Paramètres de requête invalides
401
Unauthorized - Token API invalide ou manquant
404
Not Found - Ressource non trouvée
409
Conflict - La ressource existe déjà ou incompatibilité de version
500
Internal Server Error - Erreur côté serveur survenue