Skip to content
Snippets Groups Projects
Commit 6d26f116 authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

ETSI Sandbox information

parent ebfc621d
No related branches found
No related tags found
1 merge request!40Resolve "Sandbox enrolling documentation"
This section provides users with essential details to interact with the OpenCAPIF Sandbox, including endpoint URLs, example requests, and client implementation references.
## Public Sandbox URLs
Below are the key endpoints required for API interactions within the sandbox environment:
- **Registration Service**: `https://register-opencapif.etsi.org`
- **OpenCAPIF Service**: `https://opencapif.etsi.org`
## Postman collection and flows
To facilitate API testing and integration, we provide example requests that can be used in Postman:
- **[Postman Collection for OpenCAPIF](../testing/postman/README.md)**: A ready-to-use collection with predefined requests to interact with the sandbox APIs including flows.
## Example Client Implementations
For users who wish to integrate OpenCAPIF into their applications, we provide [invoker and provider example](../example-clients/example-clients.md) clients:
- **Invoker Client**: [invoker-cli Repository](https://labs.etsi.org/rep/ocf/example-clients/invoker-cli)
- **Provider Client**: [provider-cli Repository](https://labs.etsi.org/rep/ocf/example-clients/provider-cli)
These resources are continuously updated to align with the latest OpenCAPIF developments, ensuring users have access to functional and relevant examples.
## Disclaimer
The OpenCAPIF Sandbox is a temporary and non-persistent testing environment. Any data stored within the sandbox is not backed up and may be periodically cleaned or reset without prior notice. Users should not store critical or long-term data in this environment. Always ensure that any necessary backups are maintained externally.
To request access to the OpenCAPIF Sandbox, users can choose one of the following methods:
- **Email Request**: Send an email to [OCF_TECH](mailto:OCF_TECH@list.etsi.org) with the required information.
- **Slack Channel**: Contact us through the OpenCAPIF User an Developer Communities Slack channel [#sandbox-access](https://opencapif.slack.com/archives/C08K1AJ9ZTJ) and provide the necessary details.
### Required Information
Regardless of the method chosen, users must include the following details in their request:
- **Company Name**: The name of the organization requesting access.
- **Purpose of Access**: A brief description of why access is needed.
- **Contact Information**: Email address (mandatory), telephone number (optional).
- **Preferred Username**: A desired username for the account (subject to availability; may require modification if already in use).
Once the request is received, the OpenCAPIF team will review the details and provide the necessary credentials or follow up if additional information is required.
## Disclaimer
The OpenCAPIF Sandbox is a temporary and non-persistent testing environment. Any data stored within the sandbox is not backed up and may be periodically cleaned or reset without prior notice. Users should not store critical or long-term data in this environment. Always ensure that any necessary backups are maintained externally.
The OpenCAPIF Sandbox is a dedicated environment designed to allow developers, researchers, and potential users to explore and test the latest developments in OpenCAPIF. This controlled setting provides a safe and isolated space to interact with OpenCAPIF APIs, ensuring that users can evaluate functionalities, experiment with integrations, and validate use cases without affecting live systems.
### Benefits of Using the Sandbox
- **Risk-Free Testing**: Users can experiment with the latest OpenCAPIF features without impacting production environments.
- **Hands-On Experience**: Gain practical insights into OpenCAPIF capabilities through real API interactions.
- **Rapid Prototyping**: Test and refine API integrations efficiently before deploying in real-world scenarios.
- **Up-to-Date Environment**: Always access the most recent OpenCAPIF developments and improvements.
For more details on accessing the Sandbox and utilizing its features, please refer to the following sections:
- [Request Access](./requestaccess.md): Learn how to create a user account and obtain credentials to interact with the Sandbox.
- [Relevant Information](./relevantinfo.md): Find important details such as endpoint URLs and links to example use cases in the documentation.
## Disclaimer
The OpenCAPIF Sandbox is a temporary and non-persistent testing environment. Any data stored within the sandbox is not backed up and may be periodically cleaned or reset without prior notice. Users should not store critical or long-term data in this environment. Always ensure that any necessary backups are maintained externally.
...@@ -90,6 +90,10 @@ nav: ...@@ -90,6 +90,10 @@ nav:
- Test Plan: ./testing/testplan/README.md - Test Plan: ./testing/testplan/README.md
- Robot Framework: ./testing/robotframework/README.md - Robot Framework: ./testing/robotframework/README.md
- Postman: ./testing/postman/README.md - Postman: ./testing/postman/README.md
- Sandbox:
- Introduction: ./sandbox/sandbox.md
- How to Request Access: ./sandbox/requestaccess.md
- Relevant Information: ./sandbox/relevantinfo.md
- Contribute: - Contribute:
- Documenting: ./contribute/documenting.md - Documenting: ./contribute/documenting.md
- FAQ: ./FAQ.md - FAQ: ./FAQ.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment