Articles in this section

Non-production environments and API Management

Kathyana Queeman
Updated

Warning

This feature is available in accounts created after January 28, 2025, and accounts created before January 28, 2025, without a Sandbox subscription. Multiple environments in accounts created before January 28th with a sandbox subscription will be available in March 2025.

You can benefit significantly from using API Management in non-production environments. Non-production environments allow you to maintain better control over how your API changes are developed, tested, and pushed to your API consumers. Learn more about the basics of non-production environments. With non-production environments and API Management, you can:

  • Seamlessly access the same environments in the APIM console as those available in the Celigo platform.

  • Easily define environment-specific prefixes for portal and gateway URLs, enabling greater flexibility and customization in your DevOps workflow.

  • As an admin, get automatic access to all APIs within an environment in the APIM console whenever you're newly invited to that environment in the Celigo platform.

Create a non-production environment with API Management

The API console automatically reflects your changes whenever you create a non-production environment in the Celigo platform. You don't need to change anything directly in your APIM console to benefit from the non-production environment. Simply create your new environment in the Celigo platform, and it will automatically appear in your APIM console.

Create a new environment

Warning

This feature is available in accounts created after January 28, 2025, and accounts created before January 28, 2025, without a Sandbox subscription. Multiple environments in accounts created before January 28th with a sandbox subscription will be available in March 2025.

Your first, original environment is always your Production environment. Any newly created environments are considered non-production environments. You must be in your Production environment to create a new environment. Additionally, all newly created environments are disabled by default. 

  1. Click your account profile at the upper right-hand corner of the page.

    Account_highlight.png

  2. Click Environments from the dropdown.

    Environments_account_dropdown.png

  3. Click + Create environment on the right-hand side of the page.

    Environments_create_env.png

  4. Add a Name and Description.

    Tip

    Be descriptive with your environment's name and description. For example, try NetSuite QA or NetSuite Development Sandbox instead of just QA or Test.

    Create_environment_window.png

  5. If you're using API Management, add your Environment prefix for APIM. This prefix is used to generate the Developer portal and API gateway URLs. You can change this later, but it may cause issues, as your API consumers are not notified of the change. Learn more about API Management and non-production environments.

Parity between the Celigo platform and the APIM console

When you create your environment, the following occurs:

  • The Developer Portal and Gateway URLs are automatically created, reflecting the same name you used when creating the environment.

  • An API token is automatically created for your new APIM environment.

  • New users added to the non-production environment are automatically able to access all the APIs in the new environment.

Access your environments in the APIM console

To access your newly created environments, navigate to your APIM console using the Celigo platform. The new environments are available in a dropdown on the top left-hand side of the screen.

When you push an API from the Celigo platform, it's pushed to the environment you're using in the platform. You can't push an API in a non-production environment to a production environment.