Interface Développeur

Référence API

API REST puissante pour automatiser vos flux de travail de feature flags et les intégrer à vos pipelines CI/CD existants.

Intégration du SDK

Apprenez à utiliser notre SDK officiel pour évaluer les flags dans votre application.

Installation

Sélectionnez votre gestionnaire de paquets préféré pour installer le SDK Easy Flags.

npm
npm install @orange-ember/easy-flags-sdk
yarn
yarn add @orange-ember/easy-flags-sdk
pnpm
pnpm add @orange-ember/easy-flags-sdk

Utilisation

Initialisez le client et commencez à évaluer les flags dans votre code.

1. Initialiser le Client

Importez et initialisez EasyFlagsClient avec votre clé API, ID d'Espace et ID d'Environnement.

JavaScript / TypeScript 
import { EasyFlagsClient } from "@orange-ember/easy-flags-sdk";

const client = new EasyFlagsClient({
  apiKey: "YOUR_API_KEY",
  spaceId: "YOUR_SPACE_ID",
  environmentId: "YOUR_ENVIRONMENT_ID",
});

2. Évaluer un Flag

Vérifiez si une fonctionnalité est activée ou obtenez sa valeur en utilisant la méthode evaluate.

JavaScript 
const isFeatureEnabled = await client.evaluate("new-navigation", {
  defaultValue: false,
});

if (isFeatureEnabled) {
  // Render new navigation
}

3. Ciblage Avancé (TypeScript)

Passez un userId et un objet context pour une segmentation avancée et des déploiements déterministes.

TypeScript 
const themeColor = await client.evaluate<string>("user-theme", {
  defaultValue: "#ffffff",
  userId: "user_789", // Required for deterministic rollouts
  context: {
    plan: "premium",
    version: "2.4.0"
  }
});

Options de Configuration

Property Type Description
apiKey string Votre clé API Easy Flags.
spaceId string L'ID de votre Espace.
environmentId string L'ID de votre Environnement.
cacheTTL number TTL du cache en secondes (par défaut : 60).
timeout number Délai d'attente de l'API en ms (par défaut : 5000).
Endpoints disponibles
POST /api/auth/login

Authentifier un utilisateur et obtenir un jeton JWT.

GET /api/spaces

Lister tous les espaces pour l'utilisateur authentifié.

Nécessite un jeton JWT valide dans l'en-tête d'autorisation.
POST /api/spaces/:spaceId/features

Créer une nouvelle fonctionnalité dans l'espace spécifié.

Nécessite un jeton JWT valide dans l'en-tête d'autorisation.
GET /api/spaces/:spaceId/environments

Obtenir tous les environnements d'un espace.

Nécessite un jeton JWT valide dans l'en-tête d'autorisation.
GET/POST /api/features/:featureKey/evaluate

Évaluer un feature flag spécifique pour un contexte et un environnement donnés.

Nécessite un jeton JWT valide dans l'en-tête d'autorisation.
Nécessite une clé API d'environnement.

Besoin d'une intégration personnalisée ?

Notre API est conçue pour l'évolutivité. Si vous avez des besoins spécifiques, contactez notre équipe.

Contactez le support