Arena API Endpoints¶
| Region | App URL | API URL | API Endpoints | |
|---|---|---|---|---|
| North America | https://app.bom.com | https://api.arenasolutions.com/v1 | https://api.arenasolutions.com/v1/swagger-ui/index.html# | |
| GovCloud | https://app.arenagov.com | https://api.arenagov.com/v1 | https://api.arenagov.com/v1/swagger-ui/index.html# | |
| Europe | https://app.europe.arenaplm.com | https://api.europe.arenaplm.com/v1 | https://api.europe.arenaplm.com/v1/swagger-ui/index.html# | |
| United Kingdom | https://app.uk.arenaplm.com | https://api.uk.arenaplm.com/v1 | https://api.uk.arenaplm.com/v1/swagger-ui/index.html# | |
| China | https://app.arenaplm.cn | https://api.arenaplm.cn/v1 | https://api.arenaplm.cn/v1/swagger-ui/index.html# |
Arena's API documentation is built using swagger, an interactive tool that helps developers and users understand, explore, and test APIs. It provides a clean, user-friendly interface where you can view all available endpoints, their methods (GET, POST, PUT, DELETE), required parameters, and expected responses. One of its key benefits is the ability to execute API calls directly from the documentation, making it easier to experiment and validate API behavior without writing code upfront.
FAQ: How to Use Our API Documentation Page¶
Q1: What is Swagger?¶
A: Swagger is an open-source framework for designing, building, documenting, and consuming RESTful APIs. It offers interactive documentation that allows you to test API endpoints in real time.
Q2: What information is available on our API Documentation page?¶
A: You’ll find:
- API endpoints and their descriptions
- Supported HTTP methods (GET, POST, etc.)
- Request parameters and body schemas
- Response formats and status codes
- Authentication requirements
- Example requests and responses
Q3: How do I authenticate?¶
A: 1. Click the Authorize button (usually at the top right). 2. Enter your credentials (API key, token, etc.). 3. Click Authorize again to apply them.
Q5: How do I make an API request using Arena's ?¶
A:
1. Select an endpoint from the list.
2. Click on the HTTP method (e.g., GET, POST).
3. Fill in required parameters or request body fields.
4. Click Execute to send the request.
5. Review the response displayed below.
Q6: Can I see examples of requests and responses?¶
A: Yes! Each endpoint includes sample requests and responses to guide you in formatting your data correctly.