neuron Carrier Experience API

The Try-it Playground lets you interact with the Neuron Carrier Experience API directly from your browser using simulated responses. It provides a safe, code-free way to explore endpoints, understand request structures, and preview example responses before integrating with real environments.

🔍 What is the Try-it Playground?

The playground uses a mocking service that returns example responses defined in the API specification. It behaves like the API, but without calling live backend systems.

This allows you to:

• Quickly understand how each endpoint works
• Explore request and response formats
• Test integrations early—before your real environment access is enabled
• Reduce dependency on backend availability

Since the responses are mock-generated, authentication, business rules, and live data lookups are not executed.

🧪 Why Use the Playground?

Using the Try-it feature helps you:

• Learn the API behaviour instantly
• Validate assumptions during onboarding or early development
• See examples of successful and error responses
• Experiment freely without risk to production systems

🛠️ How to Use the Try-it Playground

1. Select an Endpoint

Choose any API endpoint from the left-hand navigation panel.

2. Select “Mocking Service” from the Server Dropdown

To use the playground, always select Mocking Service.

This ensures your requests use mock data and do not reach real environments.

3. Fill in Request Details

Provide required parameters, headers, or request body fields following the example schema.

4. Click “Send”

The mocking service will return the example response defined for that endpoint—allowing you to inspect JSON outputs, status codes, and structure.

📌 General Notes

• Mocking service does not validate authentication.
• Business logic, state changes, and backend workflows are not executed in mock mode.
• Only example responses defined in the API specification are returned.

❓ Frequently Asked Questions

Q1: Why am I getting an Unauthorized error while testing?

Make sure you select Mocking Service in the server dropdown.

UAT and Production environments require valid authentication.

Q2: Why do I only see UAT, Prod, and Mocking Service in the dropdown?

Only the UAT, Production, and Mocking Service environments are exposed.

Use Mocking Service when you want to test the API in a safe, simulated environment.

Q3: Can Mocking Service be made public?

No. Mocking services follow visibility rules set by the API publisher and may not be publicly exposed.