Environments
Learn how to use Environments for testing and authentication.
The DevXP engineering team hosts office hours every Thursday at 11 a.m. Pacific Time where we answer your questions live and help you get up and running with Flatfile. Join us!
are isolated entities and are intended to be a safe place to create and test different configurations. Environments serve as self-contained, secure domains where diverse configurations can be created and tested. By default, a development and a production environment are set up.
| isProd | Name | Description |
|---|---|---|
| false | development | Use this default environment, and it’s associated test API keys, as you build with Flatfile. |
| true | production | When you’re ready to launch, create a new environment and swap out your keys. |
The development environment does not count towards your paid credits.
Creating an Environment
Your publishableKey and secretKey are specific to an environment therefore to create a new Environment, you’ll have to use a personal access token.
- Open Settings
- Click to Personal Tokens
- You can use the key pair in there to create an access token like:
curl -X POST https://platform.flatfile.com/v1/auth -H 'Content-Type: application/json' -d '{"clientId":"1234-1234", "secret":"1234-1234"}'
- The response will include an
accessToken. You can present that as your Bearertokenin place of thesecretKey.
Guest Authentication
Environments support two types of guest authentication:
magic_link: This method dispatches an email to your guests, which includes a magic link to facilitate login.shared_link: This method transforms the Space URL into a public one, typically used in conjunction with embedded Flatfile.
Additional Info
Should the guestAuthentication be left unspecified, both magic_link and shared_link types are enabled by default.
It’s important to note that guestAuthentication settings can be applied at both Environment and Space levels. However, in case of any conflicting settings, the authentication type set at the Space level will take precedence over the Environment level setting. This flexibility enables customization based on specific needs, ensuring the right balance of accessibility and security.
Secret and publishable keys
All Accounts have two key types for each environment. Learn when to use each type of key:
| Type | Id | Description |
|---|---|---|
| Secret key | sk_23ghsyuyshs7dcrty | On the server-side: Store this securely in your server-side code. Don’t expose this key in an application. |
| Publishable key | pk_23ghsyuyshs7dcert | On the client-side: Can be publicly-accessible in your application’s client-side code. Use when embedding Flatfile. |