Skip to content

Orange-OpenSource/livenet-collections

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Orange Network APIs Collections

A comprehensive repository of API collections for testing and integrating with Orange's network APIs across different environments and tools.

Overview

This repository provides ready-to-use API collections for Orange's implementation of various network APIs, including CAMARA Project APIs. Each collection is designed to work with popular API testing tools and environments.

Repository Structure

├── playground/          # Orange Network APIs Playground collections
│   ├── bruno/           # Bruno API client collection
│       └── README.md    # Playground-specific documentation
└── README.md            # This file

Available Collections

Playground Environment

Location: playground/

Test Orange's Camara Network APIs in a sandbox environment without requiring an actual network connection.

Available Tools:

  • Bruno (playground/bruno/) - Complete collection with authentication flows and all API endpoints

Features:

  • Multiple OAuth 2.0 flows (Client Credentials, Authorization Code, CIBA)
  • Automatic token management
  • Pre-configured test data
  • JWT client assertion generation

View Playground Documentation

Getting Started

Prerequisites

  • An API testing tool (Bruno, Postman, Hurl, etc.)
  • Node.js (for collections with scripts)
  • Orange API credentials from Orange Developer Portal

Installation

  1. Clone the repository:
git clone https://github.com/Orange-OpenSource/livenet-collections.git
cd livenet-collections
  1. Navigate to your desired collection:
# For Playground Bruno collection
cd playground/bruno
  1. Follow the specific collection's README for detailed setup instructions

Supported API Testing Tools

Tool Status Collections Available
Bruno ✅ Available Playground
Hurl 🔄 Planned -
IntelliJ HTTP Client 🔄 Planned -
Postman 🔄 Planned -
Insomnia 🔄 Planned -

Documentation

Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Add or improve collections for new tools or environments
  4. Test your changes thoroughly
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Contribution Guidelines

  • Follow existing folder structure for consistency
  • Include comprehensive README.md for new collections
  • Test collections before submitting
  • Update this main README when adding new collections

Roadmap

  • Hurl collections for Playground
  • IntelliJ HTTP Client collections for Playground
  • Postman collections for Playground
  • Insomnia collections for Playground

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Acknowledgments

  • CAMARA Project for the open API specifications
  • Orange Developer Community for feedback and contributions
  • API testing tool communities for their excellent platforms

Note: These collections are designed for testing and development purposes. Production usage may require different configurations and additional security considerations.

Contributors