---

Switcher API
Switching fast. Adapt everywhere.

---

About

Switcher API is a Feature Flag API with the main focus on decreasing the friction caused by changes while keeping control of what really matters.

Main features:

• Control & track more using little effort by sharing switchers among application components.

• Cross environment. Generate zero impact when manipulating your project features.

• Customizable environment strategies. Setup switchers using variables per environment.

• Delegate Switcher analysis to external services with secured Switcher Relay.

• Create manageable teams to collaborate.

• Keep track of every modification and features usage.

• Detailed metrics.

• SDKs support zero-latency mode for performance improvement.

• Exclusive Slack App to control and test changes.

• JS Client SDK: (https://github.com/switcherapi/switcher-client-js)

• Deno Client SDK: (https://github.com/switcherapi/switcher-client-deno)

• Java Client SDK: (https://github.com/switcherapi/switcher-client-java)

• Switcher Management: (https://github.com/switcherapi/switcher-management)

• Switcher Slack App: (https://github.com/switcherapi/switcher-slack-app)

---

Local setup

1. npm install
2. Add .env-cmdrc file into the project directory (use '.env-cmdrc-template')
3. Replace values such as secret keys and URLs

Running Switcher API from Docker Composer manifest file

This option leverages Switcher API and Switcher Management with minimum settings required.

1. Modify the configuration file "config/.env.dev":

• JWT_SECRET: With your secure private key
• SWITCHERAPI_URL: The Switcher API URL that Switcher Management will use internally
• SM_IP: IP/DNS used by Switcher Management internal redirects

2. Run:

docker-compose --env-file ./config/.env.dev up -d

3. Open Switcher Management:

http://localhost

Quick start

Open Swagger UI by accessing the URL: http://localhost:3000/api-docs
Or use Postman by importing either the OpenAPI json from http://localhost:3000/swagger.json or Postman Collection from "requests/Switcher API*"

API configuration

Signing up

Signing up an account to use Switcher API with an email/password or linking it to a GitHub or Bitbucket account.

• Singing up via email - Admin: /admin/signup [POST]
• Singing up via GitHub - Admin: /admin/github/auth?code= [POST]
• Singing up via Bitbucket - Admin: /admin/bitbucket/auth?code= [POST]
• Access confirmation - Admin: /admin/signup/authorization?code= [POST]

Domain

Domains are responsible for centralizing all settings and configurations.
It is equivalent to an organization that can manage multiple projects, users, and environments.

• New domain - Domain: /domain/create [POST]

Component

Components are applications that are using Switcher API.
Each component has its own access token and needs to be linked to Switchers.

• Create a component - Component: /component/create [POST]
• Generating a new API Key - Component: /component/generateApiKey [GET]

Group

Groups are used to organize Switchers that share the same feature scope.

• New Group - GroupConfig: /groupconfig/create [POST]

Switcher

Switchers are the main entities to control features.

• New Switcher - Config: /config/create [POST]

Strategy

Customize the behavior of the Switcher by including strategy rules to your Switchers.

• New Strategy - ConfigStrategy: /configstrategy/create [POST]

API usage

In order to use Switcher API, you need to authenticate the component before using it.
See also our SDKs to integrate Switcher API with your application.

• Auth - Client API: /criteria/auth [POST]
• Executing - Client API: /criteria?key=SWITCHER_KEY [POST]