neuron Carrier Experience API
ebw-f9u/Getting Started ๐
Steps
Follow the steps below to begin integrating with Neuronโs Carrier Experience API. Each step is designed to help you set up authentication, understand the environments, explore available endpoints, and make your first successful mock API call.
1. Review the Authentication Requirements
Learn how to authenticate using JWT tokens together with client_id enforcement.
See: Authentication Guide
2. Identify the Correct Environment
Use UAT for testing your integration before moving to Production.
See: Environments Guide
3. Explore API Resources
Browse endpoints, payload formats, filtering options, and expected responses.
See: API Resources
4. Test Your First Request
Use the Try-it console.
See: API Playground
5. Understand Error Handling
Review structured error responses and correlation IDs to support troubleshooting.
๐ Useful Navigation
Use the links below to move quickly between key documentation pages: