Ana içeriğe atla

​
Base URL

The Management API base URL is constructed by appending /apiops to your Apinizer Manager application URL.

​
Format

{management_console_url}/apiops/

​
Examples

Manager URLAPI Base URL
https://demo.apinizer.comhttps://demo.apinizer.com/apiops/
http://localhost:8080http://localhost:8080/apiops/
https://apinizer.company.comhttps://apinizer.company.com/apiops/

​
Endpoint Structure

All Management API endpoints follow a consistent structure: 
{base_url}/{resource_path}/

​
Common Resource Paths

  • /apiops/projects/ - Project management
  • /apiops/environments/ - Environment management
  • /apiops/projects/{projectName}/apiProxies/ - API Proxy management
  • /apiops/projects/{projectName}/policies/ - Policy management
  • /apiops/projects/{projectName}/connections/ - Connection management
  • /apiops/projects/{projectName}/credentials/ - Credential management
  • /apiops/projects/{projectName}/certificates/ - Certificate management

​
Path Parameters

Path parameters are used to identify specific resources: 
/apiops/projects/{projectName}/apiProxies/{apiProxyName}/
Where:
  • {projectName} - The name of the project
  • {apiProxyName} - The name of the API proxy

​
Path Parameter Rules

  • Path parameters are Case Sensitive
  • Use the exact name as it appears in the system
  • Special characters should be URL-encoded if needed
  • Spaces are not allowed in names (use hyphens or underscores)

​
Query Parameters

Query parameters are optional and used for filtering, pagination, etc.: 
/apiops/projects/?page=1&size=10

​
Common Query Parameters

ParameterTypeDescription
pageintegerPage number (for pagination)
sizeintegerPage size (for pagination)
sortstringSort field and direction (e.g., name,asc)

​
Trailing Slashes

All endpoints end with a trailing slash (/): ✅ Correct: 
/apiops/projects/
/apiops/projects/{projectName}/apiProxies/
❌ Incorrect: 
/apiops/projects
/apiops/projects/{projectName}/apiProxies

​
URL Encoding

When using path or query parameters with special characters, ensure proper URL encoding:
  • Space → %20 or +
  • / → %2F
  • ? → %3F
  • # → %23
  • & → %26
  • = → %3D

​
Example

If your project name is My Project, encode it as My%20Project: 
/apiops/projects/My%20Project/apiProxies/

​
HTTPS vs HTTP

  • Production: Always use HTTPS
  • Development: HTTP may be acceptable for local development

​
Environment-Specific URLs

Different environments may have different base URLs:
  • Development: http://localhost:8080/apiops/
  • Staging: https://staging.apinizer.com/apiops/
  • Production: https://demo.apinizer.com/apiops/

​
Next Steps