How to create an API Integration

Getting started

Set up authentication and ensure you have access to the API Integrations section in your Plate dashboard.

Creating an API Integration

Step 1: Access the Dashboard

1. Log into your Plate dashboard
2. Navigate to the appropriate level (Partner, Company, or Site)
3. Go to the "API Integrations" section at the bottom of the sidebar

Use Partner, Company or Site level depending on your level access

Step 2: Create Integration

1. Create a new integration
2. Provide a descriptive name for your integration
3. Save the integration

Step 3: Generate API Keys

1. Select your newly created integration
2. Create a new key
3. Important: Copy both the public key and secret key immediately
4. The secret key will only be shown once and cannot be retrieved later
5. To activate a key, click the switch in the "active" column. Your key is now ready to use.

The secret key is displayed only once. If you lose it, you must generate a new key.

The maximum number of keys per level is 2.

Step 4: Configure Permissions

1. Navigate to the integration's authorization settings
2. Enable the specific permissions your integration needs:
   • Read permissions: View resources
   • Create permissions: Create new resources
   • Update permissions: Modify existing resources
   • Delete permissions: Remove resources
3. You can change the authorization settings for the following resources:
   • Partner
   • Company
   • Site
     • Settings
     • Content
     • Content Model
     • Theme Files
     • Theme Settings
4. Click on a tile to allow access. Click a second time to deny access.

Step 5: Test Your Integration

Use the API home endpoint to verify your integration is working:

curl -X GET "https://www.startwithplate.com/api/v2" \
  -H "Date: $(date -u +'%a, %d %b %Y %H:%M:%S GMT')" \
  -H "Authorization: hmac YOUR_PUBLIC_KEY:YOUR_SIGNATURE"

Go to Authentication and Authorization to calculate your signature

If your integration is functioning correctly, you should get the following response:

{
  "welcome": "Welcome to the Plate REST API v2",
  "info": {
    "integration": {
      "level": "site|company|partner",
      "level_record": {
        "id": 1234,
        "name": "Your Site Name",
        "company_id": 5678,    // only for sites
        "partner_id": 9012     // only for companies and sites
      }
    }
  }
}

If authentication fails, you'll receive a 401 error:

{
  "error": "Unauthorized",
  "message": "Invalid or missing authentication"
}