App Management API

The App Management API allows you to programmatically create, retrieve, update, and delete apps in your Appizer organization without using the dashboard.

Base URL

https://api.appizer.com/v1/apps

Authentication

All App Management API requests require authentication using your Organization API Key:

X-API-Key: apps_your_organization_api_key

The API key must be included in the X-API-Key header of every request.

Getting Your API Key

Organization admins can find and regenerate their API key in the Organization Settings:

1. Log in to your Appizer dashboard
2. Navigate to Settings (gear icon)
3. Scroll to the "App Management API" section
4. Copy your API key or regenerate it if needed

Request Format

All requests must include the following headers:

X-API-Key: apps_your_api_key
Content-Type: application/json

Response Format

All responses are returned in JSON format with the following structure:

{
  "success": true,
  "app": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My App",
    ...
  }
}

Error responses:

{
  "error": "Error message describing what went wrong"
}

Common Fields

All app objects returned by the API contain the following fields:

Available Endpoints

1. Create an App - POST /v1/apps
2. List Apps - GET /v1/apps
3. Get App Details - GET /v1/apps/:id
4. Update App - PATCH /v1/apps/:id
5. Delete App - DELETE /v1/apps/:id

Error Handling

The API returns standard HTTP status codes:

• 200 OK - Request successful
• 201 Created - Resource created successfully
• 400 Bad Request - Invalid request parameters
• 401 Unauthorized - Missing or invalid API key
• 403 Forbidden - API key disabled
• 404 Not Found - Resource not found
• 500 Internal Server Error - Server error

Error responses include an error field with a description:

{
  "error": "App name is required and must be 1-100 characters"
}

Rate Limiting

Currently, there are no rate limits on the App Management API. However, we recommend implementing reasonable delays between requests to avoid overwhelming the server.

Best Practices

1. Secure Your API Key - Treat your API key like a password. Never commit it to version control.
2. Use HTTPS - Always use HTTPS when making API requests.
3. Handle Errors Gracefully - Check status codes and handle errors appropriately in your application.
4. Validate Input - Validate all input data before sending requests.
5. Store Safely - Store API keys in environment variables or secure configuration files.

Examples

Create an App (Node.js)

const fetch = require('node-fetch');

const apiKey = 'apps_your_api_key';
const appData = {
  name: 'My New App',
  description: 'My awesome app',
  timezone: 'America/New_York'
};

const response = await fetch('https://api.appizer.com/v1/apps', {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(appData)
});

const result = await response.json();
if (result.success) {
  console.log('App created:', result.app.id);
} else {
  console.error('Error:', result.error);
}

List All Apps (Python)

api_key = 'apps_your_api_key'
headers = {
    'X-API-Key': api_key,
    'Content-Type': 'application/json'
}

response = requests.get('https://api.appizer.com/v1/apps', headers=headers)
result = response.json()

if result.get('success'):
    for app in result['apps']:
        print(f"App: {app['name']} ({app['id']})")
else:
    print(f"Error: {result.get('error')}")

Next Steps

• Create your first app
• View full API documentation
• Check out integration examples