Interfaz para Desarrolladores

Referencia API

API REST potente para automatizar tus flujos de trabajo de banderas de función e integrarlos con tus tuberías de CI/CD existentes.

Integración del SDK

Aprende a usar nuestro SDK oficial para evaluar flags en tu aplicación.

Instalación

Selecciona tu gestor de paquetes preferido para instalar el SDK de 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

Uso

Inicializa el cliente y comienza a evaluar flags en tu código.

1. Inicializar el Cliente

Importa e inicializa EasyFlagsClient con tu API Key, ID de Espacio e ID de Entorno.

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. Evaluar una Flag

Comprueba si una característica está activada o obtén su valor usando el método evaluate.

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

if (isFeatureEnabled) {
  // Render new navigation
}

3. Segmentación Avanzada (TypeScript)

Pasa un userId y un objeto context para segmentación avanzada y rollouts deterministas.

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"
  }
});

Opciones de Configuración

Property Type Description
apiKey string Tu API Key de Easy Flags.
spaceId string El ID de tu Espacio.
environmentId string El ID de tu Entorno.
cacheTTL number TTL del caché en segundos (por defecto: 60).
timeout number Tiempo de espera de la API en ms (por defecto: 5000).
Puntos de Acceso Disponibles
POST /api/auth/login

Autenticar a un usuario y obtener un token JWT.

GET /api/spaces

Enumerar todos los espacios para el usuario autenticado.

Requiere un token JWT válido en el encabezado de autorización.
POST /api/spaces/:spaceId/features

Cree una nueva función en el espacio especificado.

Requiere un token JWT válido en el encabezado de autorización.
GET /api/spaces/:spaceId/environments

Obtenga todos los entornos en un espacio.

Requiere un token JWT válido en el encabezado de autorización.
GET/POST /api/features/:featureKey/evaluate

Evaluar una bandera de función específica para un contexto y entorno determinados.

Requiere un token JWT válido en el encabezado de autorización.
Requiere una Clave de API de entorno.

¿Necesitas una integración personalizada?

Nuestra API está construida para escalar. Si tienes necesidades específicas, contacta a nuestro equipo.

Contactar Soporte