Introduction

Welcome to the Plate REST API documentation. In this documentation you will find a guide on how to use the Plate API.

Available libraries

For the Plate API, a rubygem is available.

API Usage

The following sections describe how to connect to the Plate API.

Connecting to the Plate API

Any application can connect to the Plate API using an HTTP request with a certain method to an endpoint, with some parameters. The resources section of the documentation describes the details of all available endpoints, such as the endpoint itself, the required HTTP method and the permitted/required parameters.

Method

The HTTP method of a request should be one of [GET, PUT, POST, DELETE].

Endpoint

These endpoints (urls) of the API are structured as follows: www.startwithplate.com/api/v2/{specific_path}, where {specific_path} represents a path corresponding to a certain action. {specific_path} could for example be partners/1/companies, so the complete endpoint would be www.startwithplate.com/api/v2/partners/1/companies. This path corresponds to the index of all companies for the partner with id 1.

Parameters

Each HTTP request can contain three types of parameters: URL parameters, Query parameters and POST/PUT parameters.

URL parameters

An URL parameter is one that is part of the endpoint itself. These parameters mostly correspond to an id of a certain resource. The endpoint www.startwithplate.com/api/v2/partners/1/companies contains the URL parameter :partner_id with value 1, indicating that only companies of the partner with id 1 should be returned.

Query parameter

A Query parameter is one that is appended to the endpoint in the form of a query string. They can be used to convey information about for example pagination The endpoint www.startwithplate.com/api/v2/partners/1/companies?pagination_page=3 contains the Query parameter pagination_page with value 3, indicating that the third page of the pagination should be returned.

POST/PUT parameters

{
  "data":{
    "name": "A new name",
    "path": "/some/random/path"
  }
}

A POST/PUT parameter is one that is sent in the body of a POST or PUT request. Plate requires this body to be structured in JSON format. The description of each endpoint in the resources section also describes the accepted POST/PUT parameters.

The example shown aside, shows how to submit the POST parameters name and path.

Authentication and Authorization

To authenticate a request, it has to be accompanied by authentication details. The authentication details consist of 2 parts, a public key and a signature calculated using the secret key. If a request is authenticated correctly, it will also be authorized.

Integration

To create a key pair (a public and a secret key), you have to create a so-called integration in the Plate dashboard. An integration represents an external application that interacts with the Plate API. When you create an integration, you are able to create a key pair.

Authentication procedure

To authenticate a request, two headers have to be sent with the request: the Date header and the Authorization header.

Date header

The Date header should contain the current time, formatted according to RFC 7231. A request will be unauthorized if this date is more than 15 minutes past the time at which the server receives this request.

Authorization header

The Authorization consists of 3 parts: hmac {public_key}:{signature}.

• hmac: The authentication protocol used, and is not variable.
• {public_key}: The public key of the integration that you want to use for authenticating this request.
• {signature}: The signature of this request, which is calculated using the secret key matching the {public_key}.

Calculating the signature

The layout of the string to sign of a request

{http_method}
{url_domain}
{url_path}
{query_string}
{http_date}

To calculate the signature of a request, first the string to sign has to be setup. The layout of the string to sign is shown to the right.

An example string to sign (note that paginate_amount and paginate_page are fictional parameters, and only there as an example)

GET
www.startwithplate.com
/api/v2/partners/15/sites
paginate_amount=10&paginate_page=2
Sun, 06 Nov 1994 08:49:37 GMT

The valid Authorization header given the above string to sign is

Authorization hmac mypublickey:FOjhvBsNceYeVNAJtneSLUeYbNO133Gj1sx+aEu7I8A2ixH3VyYpc6PtxGDGVzpG1EPrDaL7sgurV2Q0+8BHDQ==

The string to sign consists of the following parts:

• {http_method}: The HTTP method of the request, e.g. GET or POST.
• {url_domain}: The domain part of the url, without the protocol, path or query parameters.
• {url_path}: The path part of the url, e.g. /api/v2/partners/15
• {query_string}: The query string part of the url. Note that the parameters should be sorted alphabetically, based on the key of the parameters. So key=value&alpha=beta is incorrect, but alpha=beta&key1=value is correct.
• {http_date}: The value that is set in the Date header.

To get the signature, the HMAC based on the string to sign has to be calculated, as defined in RFC 2104, using the SHA512 hash algorithm. The key that is used for the HMAC, is the secret key that corresponds to the public key that is used in the authorization header, alongside the signature. The signature has be send in base64 representation, so not in a hexadecimal representation.

Example

The HMAC of the example string to sign (shown to the right), with a secret key of mysecretkey, would be: FOjhvBsNceYeVNAJtneSLUeYbNO133Gj1sx+aEu7I8A2ixH3VyYpc6PtxGDGVzpG1EPrDaL7sgurV2Q0+8BHDQ==.

So given a key pair with a public key of mypublickey and a secret key of mysecretkey, and a request with:

• The method GET
• The url www.startwithplate.com/api/v2/partners/15/sites?paginate_amount=10&paginate_page=2
• A Date header of Sun, 06 Nov 1994 08:49:37 GMT

the valid Authorization header would be:

hmac mypublickey:FOjhvBsNceYeVNAJtneSLUeYbNO133Gj1sx+aEu7I8A2ixH3VyYpc6PtxGDGVzpG1EPrDaL7sgurV2Q0+8BHDQ==

Pagination

To prevent unmanageable response sizes, all index endpoints are paginated. Each page contains a number of records, and if the total number of records exceeds the number of records on a page, a next page will be available.

Pagination response keys

GET {base_url}/site_translations/1/posts returns the following json. Note that total_pages equals 2 since total_records > per_page

{
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 250,
      "total_records": 276,
      "total_pages": 2
    }
  },
  "data": [
    ...
  ]
}

Each index endpoint will return a pagination keys. These will be located in the pagination object inside the meta object in a response. The following keys will be present:

Pagination request keys

GET {base_url}/site_translations/15/posts?page=3&per_page=15 returns the following json. Note that total_pages equals 2 since total_records > per_page

{
  "meta": {
    "pagination": {
      "page": 3,
      "per_page": 15,
      "total_records": 50,
      "total_pages": 4
    }
  },
  "data": [
    ...
  ]
}

To change the pagination parameters, some url parameters can be send with the request. These will for example allow to change the page that is returned in the response, or the number of records that is returned per page. The following pagination keys are accepted:

Content Objects

Some of the resources available through the Plate API have a dynamic set of content fields. These content fields can be defined through the Plate dashboard. Resources which have such content fields are called content objects. Examples of content objects are site translations, posts, sections and elements. The endpoints for content objects have some specific features/requirements.

Responses for content objects

A GET endpoint for a content object may return JSON as follows:

{
  "data": {
    "id": 1,
    "type": "elements",
    "attributes": {
      "content": {
        "categories": {
          "value": [789],
          "type": "reference",
          "subtype": "posts",
          "content_field_id": 123
        },
        "name": {
          "value": "Pied Piper",
          "type": "string",
          "content_field_id": 456
        }
      },
      ...
    },
    ...
  }
}

For endpoints of content objects, the JSON response is expanded with the values set for the content fields of the content objects.

Consider an element with id=5, having two content fields:

• categories (A reference content field to a Post)
• name (A text content field)

An example response is shown aside.

As can be seen in the example response, the API will return an extra property in the "attributes" objects, named "content", next to the 'standard' attributes. The "content" object in the response contains an object for each of the content fields of the selected object (the element, in the example). Each content field object contains the properties of that content field for the content object.

For each content field, the following properties are returned:

Value

The value property can be of different types - it can be a string, integer or array, depending of the type of content field. So the type property can be used to deduce the meaning of the value found in the value property.

For reference fields, the value property will be an array of numbers. These numbers are ID's of referenced resources for the content field. The subtype property will indicate what kind of resource is selected/referenced.

For array fields, the value property will be an array of numbers or strings, depending on the subtype property. If the subtype property equals attachments, the value property will be an array of numbers, representing attachments. If the subtype property equals text, then the value property will be an array of strings, which is the actual value of the content field.

Requests for content objects

A request to a POST endpoint for a content object may contain data as follows:

{
  "data": {
    ...
    "name": "A name for the new element",
    "categories": [
      {
        "id": 25
      },
      {
        "title": "A title for a newly created reference post"
        ...
      }
    ]
  }
}

For PUT/POST endpoints of content objects, the data sent with the request also can contain data for the content fields for content objects. Consider creating an element with a post type that has the following content fields:

• name (A text content field)
• categories (A reference content field to a Post)

An example of request data is shown aside.

As can be seen in the example, for each content field an object or value is provided in the request data.

• For content fields which take plain values, such as content fields with type string or choice, the plain value is given. This value can be a string or integer.
• For content fields with type media, the value has to be an id of an existing attachment.
• For content fields with type reference, the value has to be an array of objects. This object can consist of either an id of an existing object to reference to, or the data for a new object to reference to.

Positionable Objects

Some of the resources available through the Plate API, are so called positionable objects. These objects can be positioned within their parent. For example, sections can be positioned within a post, and rows within a section.

Inside a specific parent, each positionable object has a unique, sequential position. This means that if there are 4 positionable objects inside 1 parent, each object will have a property position with value equal to one of [1,2,3,4].

For example, if there are 3 sections inside a post:

• The first section will have position=1
• The second section will have position=2
• The last section position=3.

The following constraint for values of the position attribute of a positionable object holds:

A GET endpoint for a positionable object may return JSON as follows:

{
  "data": {
    "id": 1,
    "type": "elements",
    "attributes": {
      "position": 1,
      ...
    },
    ...
  }
}

Responses for positionable objects

The current position of a positionable object is returned in responses, as a property inside the attributes object. See the example aside.

Requests for positionable objects

A request to a POST endpoint for a positionable object may contain data as follows:

{
  "data": {
    "position": 2,
    ...
  }
}

The position of a positionable object can be set in POST/PUT requests. This can be done by giving the position property inside the POST/PUT parameters. See the example aside.

The values given for the position property have to fall within the constraint on the position.

Errors

For example when a partner with id=1 does not exist: GET {base_url}/partners/1

{
  "errors": [
    {
      "id": 1,
      "resource_type": "partner",
      "status": "404",
      "code": "not-found",
      "title": "Partner not found",
      "detail": "A partner with id=1 could not be found"
    }
  ]
}

If a request is invalid, Plate will return a corresponding HTTP status, accompanied by clarifying error messages. These error messages will be send in the JSON response, in the errors array. (See example) These errors can contain the following keys:

The following errors can be returned by Plate:

400 Bad Request

The provided request does not match with the required syntax. Read the documentation for the valid syntax.

401 Unauthorized

The provided authentication details do not match any valid integration according to the authentication requirements. Please follow these requirements with an activated integration key.

403 Forbidden

The request was understood, but the authenticated integration is not allowed to perform this action.

404 Not Found

One or more resources specified in the request could not be found.

422 Unprocessable entity

The request was understood and authorized, but the data provided does not match the requirements. For example one of the validations of a provided content field was not matched, or a required attribute was not given.

429 Too Many Requests

The server received too many requests, please slow down the rate of requests. The rate limiting is implemented using the Sliding Log mechanism. This means that for each partition in time, a certain amount of requests is allowed. Currently, the allowed number of requests is 50 requests per 5000 milliseconds.

This means that the following sequence of requests will exceed the rate limit:

• (t = 0 seconds): 10 requests
• (t = 1 seconds): 10 requests
• (t = 2 seconds): 10 requests
• (t = 3 seconds): 10 requests
• (t = 4 seconds): 11 requests

Since at t=4, more than 50 request have been executed in the past 5 seconds.

However the following sequence of requests will not exceed the rate limit:

• (t = 0 seconds): 9 requests
• (t = 1 seconds): 19 requests
• (t = 2 seconds): 0 requests
• (t = 3 seconds): 0 requests
• (t = 4 seconds): 10 requests
• (t = 5 seconds): 20 requests
• (t = 6 seconds): 19 requests

Since at every value for t, the amount of requests in the past 5 seconds is at most 50. (At t=4, the total count in the previous 5 seconds is 48, at t=5, 49, and at t=6, 49 as well)

500 Internal Server Error

An error occurred while executing your request. Please try again later, or contact info@getplate.com for help.

Filtering

To allow for efficient retrieval of a specific set of objects, the Plate API allows to filter Index endpoints based on id. This way you can retrieve n specified objects in one request, instead of making n requests.

This is done by adding a query parameter id[]={id_value} for each object you want to retrieve. For example, to retrieve the posts with ids [1, 5, 6], send a GET request shown beside.

To retrieve posts with ids [1,5,6] at once, make the following request: GET {base_url}/site_translation/12/posts?id[]=1&id[]=5&id[]=6

This functionality is currently active for:

• Site Translations
• Posts
• Sections
• Elements
• Content Objects
• Authentication Objects

Resources

Partners

Get specific partner

GET {base_url}/partners/1 returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "partners",
    "attributes": {
      "name": "Partner Name 1"
    },
    "relations": {}
  }
}

This endpoint retrieves a specific partner.

HTTP Request

GET {base_url}/partners/:id

URL Parameters

Update partner

An example of valid JSON PUT parameters

{
  "data": {

    "name": "New Partner name"
  }
}

PUT {base_url}/partners/1 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "partners",
    "attributes": {
      "name": "New Partner name"
    },
    "relations": {}
  }
}

This endpoint updates a specific partner.

HTTP Request

PUT {base_url}/partners/:id

URL Parameters

PUT Parameters

Companies

Get all companies

GET {base_url}/partners/1/companies/ returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "type": "companies",
      "attributes": {
        "name": "Company Name 1",
        "street_name": "Somestreet",
        "street_no": "5",
        "street_suffix": "a",
        "city": "Ede",
        "zipcode": "6734 AT",
        "country": "Netherlands",
        "phone": "+3123456789",
        "kvk_number": "0123456789",
        "vat_number": "9876543210",
        "invoice_contact_first_name": "Johannes",
        "invoice_contact_last_name": "Pleet",
        "invoice_contact_email": "johannes@getplate.com"
      },
      "relations": {
        "partner_id": 1
      }
    },
    {
      "id": 2,
      "type": "companies",
      "attributes": {
        "name": "Company Name 2",
        "street_name": "Somestreet",
        "street_no": "5",
        "street_suffix": "a",
        "city": "Ede",
        "zipcode": "6734 AT",
        "country": "Netherlands",
        "phone": "+3123456789",
        "kvk_number": "0123456789",
        "vat_number": "9876543210",
        "invoice_contact_first_name": "Johannes",
        "invoice_contact_last_name": "Pleet",
        "invoice_contact_email": "johannes@getplate.com"
      },
      "relations": {
        "partner_id": 1
      }
    }
  ]
}

This endpoint retrieves all companies in a specific partner.

HTTP Request

GET {base_url}/partners/:partner_id/companies

URL Parameters

Get specific Company

GET {base_url}/partners/1/companies/1 returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "companies",
    "attributes": {
      "name": "Company Name 1",
      "street_name": "Somestreet",
      "street_no": "5",
      "street_suffix": "a",
      "city": "Ede",
      "zipcode": "6734 AT",
      "country": "Netherlands",
      "phone": "+3123456789",
      "kvk_number": "0123456789",
      "vat_number": "9876543210",
      "invoice_contact_first_name": "Johannes",
      "invoice_contact_last_name": "Pleet",
      "invoice_contact_email": "johannes@getplate.com"
    },
    "relations": {
      "partner_id": 1
    }
  }
}

This endpoint retrieves a specific company.

HTTP Request

GET {base_url}/companies/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/partners/:partner_id/companies/:id

Create company

An example of valid JSON POST parameters

{
  "data": {    
    "name": "Created Company Name 1",
  }
}

POST {base_url}/partners/1/companies with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "companies",
    "attributes": {
      "name": "Created Company Name 1",
      "street_name": "",
      "street_no": "",
      "street_suffix": "",
      "city": "",
      "zipcode": "",
      "country": "",
      "phone": "",
      "kvk_number": "",
      "vat_number": "",
      "invoice_contact_first_name": "",
      "invoice_contact_last_name": "",
      "invoice_contact_email": ""
    },
    "relations": {
      "partner_id": 1
    }
  }
}

This endpoint creates a company.

HTTP Request

POST {base_url}/partners/:partner_id/companies

URL Parameters

POST Parameters

Update company

An example of valid JSON PUT parameters

{
  "data": {    
    "name": "New Company name"
  }
}

PUT {base_url}/partners/1/companies/1 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "companies",
    "attributes": {
      "name": "New Company name",
      "street_name": "Somestreet",
      "street_no": "5",
      "street_suffix": "a",
      "city": "Ede",
      "zipcode": "6734 AT",
      "country": "Netherlands",
      "phone": "+3123456789",
      "kvk_number": "0123456789",
      "vat_number": "9876543210",
      "invoice_contact_first_name": "Johannes",
      "invoice_contact_last_name": "Pleet",
      "invoice_contact_email": "johannes@getplate.com"
    },
    "relations": {
      "partner_id": 1
    }
  }
}

This endpoint updates a specific company.

HTTP Request

PUT {base_url}/companies/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/partners/:partner_id/companies/:id

Delete company

DELETE {base_url}/partners/1/companies/1 returns JSON structured like this:

{
  "data": {
    "id": 1,
    "name": "Company Name 1"
  }
}

This endpoint deletes a specific company.

HTTP Request

DELETE {base_url}/companies/:id

URL Parameters

Constraints

This endpoint has the following constraints:

• There should be no sites in the company with id :id

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/partners/:partner_id/companies/:id

Sites

Get all sites

GET {base_url}/partners/1/companies/1/sites/ returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "type": "sites",
      "attributes" : {
        "name": "Site name 1",
        "languages": "nl,en",
        "main_language": "nl",
        "param_key": "aea00cde61",
        "technical_contact_name": "David",
        "technical_contact_email": "david@getplate.com",
        "status": "creating",
        "is_theme_base_site": false
      },
      "relations" : {
        "company_id": 1,
        "theme_id": 1
      }
    },
    {
      "id": 2,
      "type": "sites",
      "attributes" : {
        "name": "Site name 2",
        "languages": "nl,en,de",
        "main_language": "nl",
        "param_key": "aec91acccc",
        "technical_contact_name": "Kobus",
        "technical_contact_email": "kobus@getplate.com",
        "status": "ready",
        "is_theme_base_site": false
      },
      "relations": {
        "company_id": 1,
        "theme_id": 123,
      }
    }
  ]
}

This endpoint retrieves all sites in a specific company.

HTTP Request

GET {base_url}/companies/:company_id/sites

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/partners/:partner_id/sites/ (Gives all sites in a partner)

Get specific Site

GET {base_url}/companies/1/sites/2 returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "sites",
    "attributes" : {
      "name": "Site name 2",
      "languages": "nl,en,de",
      "main_language": "nl",
      "param_key": "aec91acccc",
      "technical_contact_name": "Kobus",
      "technical_contact_email": "kobus@getplate.com",
      "status": "ready",
      "is_theme_base_site": false
    },
    "relations" : {
      "theme_id": 123,
      "company_id": 1
    }
  }
}

This endpoint retrieves a specific site.

HTTP Request

GET {base_url}/sites/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/companies/:company_id/sites/:id

Create site

An example of valid JSON POST parameters

{
  "data": {    
    "name": "Created site",
    "theme_id": 1,
    "languages": "nl,en",
    "main_language": "en",
    "technical_contact_name": "Pieter",
    "technical_contact_email": "pieter@getplate.com",
    "initial_subdomain": "my-created-site"
  }
}

POST {base_url}/companies/3/sites with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "sites",
    "attributes": {
      "name": "Created site",
      "languages": "nl,en",
      "main_language": "en",
      "param_key": "aec91acccc",
      "technical_contact_name": "Pieter",
      "technical_contact_email": "pieter@getplate.com",
      "status": "creating",
      "is_theme_base_site": false
    },
    "relations": {
      "theme_id": 1,
      "company_id": 3,
    }
  }
}

This endpoint creates a site.

HTTP Request

POST {base_url}/companies/:company_id/sites

URL Parameters

POST Parameters

Update site

An example of valid JSON PUT parameters

{
  "data": {    
    "name": "New name"
  }
}

PUT {base_url}/companies/3/sites/3 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "sites",
    "attributes": {
      "name": "New name",
      "languages": "nl,en",
      "main_language": "en",
      "param_key": "aec91acccc",
      "technical_contact_name": "Pieter",
      "technical_contact_email": "pieter@getplate.com",
      "status": "ready",
      "is_theme_base_site": false
    },
    "relations": {
      "theme_id": 1,
      "company_id": 3,
    }
  }
}

This endpoint updates a site.

HTTP Request

PUT {base_url}/sites/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/companies/:company_id/sites/:id

Delete site

DELETE {base_url}/companies/1/sites/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "sites",
    "attributes": {
      "name": "New name",
      "languages": "nl,en",
      "main_language": "en",
      "param_key": "aec91acccc",
      "technical_contact_name": "Pieter",
      "technical_contact_email": "pieter@getplate.com",
      "status": "ready",
      "is_theme_base_site": false
    },
    "relations": {
      "theme_id": 1,
      "company_id": 3,
    }
  }
}

This endpoint deletes a specific company.

HTTP Request

DELETE {base_url}/sites/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/companies/:company_id/sites/:id

Themes

Get all themes

GET {base_url}/partners/1/themes/ returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "type": "themes",
      "attributes" : {
        "name": "Theme name 1",
        "languages": "nl,en",
        "main_language": "nl",
        "status": "creating"
      },
      "relations" : {
        "partner_id": 1,
        "site_id": 22
      }
    },
    {
      "id": 2,
      "type": "themes",
      "attributes" : {
        "name": "Theme name 2",
        "languages": "nl",
        "main_language": "nl",
        "status": "unpublished"
      },
      "relations" : {
        "partner_id": 1,
        "site_id": 23
      }
    }
  ]
}

This endpoint retrieves all themes for a specific partner

HTTP Request

GET {base_url}/partners/:partner_id/themes

URL Parameters

Get specific Theme

GET {base_url}/partners/1/themes/2 returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "themes",
    "attributes" : {
      "name": "Theme name 2",
      "languages": "nl",
      "main_language": "nl",
      "status": "unpublished"
    },
    "relations" : {
      "partner_id": 1,
      "site_id": 23
    }
  }
}

This endpoint retrieves a specific Theme.

HTTP Request

GET {base_url}/partners/:partner_id/themes/:id

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/theme/:id

URL Parameters

Create theme

An example of valid JSON POST parameters

{
  "data": {    
    "name": "Created theme",
    "copy_from_theme_id": 1,
    "languages": "nl,de",
    "main_language": "de",
    "initial_subdomain": "my-created-theme-example-site"
  }
}

POST {base_url}/partners/3/themes with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "themes",
    "attributes" : {
      "name": "Created theme",
      "languages": "nl,de",
      "main_language": "de",
      "status": "creating"
    },
    "relations" : {
      "partner_id": 3,
      "site_id": 29
    }
  }
}

This endpoint creates a theme.

HTTP Request

POST {base_url}/partners/:partner_id/themes

URL Parameters

POST Parameters

Update theme

An example of valid JSON PUT parameters

{
  "data": {    
    "name": "New name"
  }
}

PUT {base_url}/partners/3/themes/5 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "themes",
    "attributes" : {
      "name": "New name",
      "languages": "nl,de",
      "main_language": "de",
      "status": "creating"
    },
    "relations" : {
      "partner_id": 3,
      "site_id": 29
    }
  }
}

This endpoint updates a theme.

HTTP Request

PUT {base_url}/themes/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/partners/:partner_id/themes/:id

Delete theme

DELETE {base_url}/partners/3/themes/5 returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "themes",
    "attributes" : {
      "name": "New name",
      "languages": "nl,de",
      "main_language": "de",
      "status": "creating"
    },
    "relations" : {
      "partner_id": 3,
      "site_id": 29
    }
  }
}

This endpoint deletes a specific theme.

HTTP Request

DELETE {base_url}/themes/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/partners/:partner_id/themes/:id

Theme files

Get all theme files

GET {base_url}/sites/1/theme_files/ returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "type": "theme_files",
      "attributes" : {
        "etag": "a2b67bf1906313e9f98c3c0a2bbb7b4c",
        "path": "posts",
        "file_name": "index",
        "extension": "plate",
      },
      "relations" : {
        "site_id": 1,
      }
    },
    {
      "id": 2,
      "type": "theme_files",
      "attributes" : {
        "etag": "ef8192015354713e9f98c3c0a2ec76ec",
        "path": "posts",
        "file_name": "show",
        "extension": "plate",
      },
      "relations" : {
        "site_id": 1,
      }
    }
  ]
}

This endpoint retrieves all theme files for a specific site

HTTP Request

GET {base_url}/sites/:site_id/theme_files

URL Parameters

Download all theme files

This endpoint returns all theme files of a specific site packed together in a zip file.

HTTP Request

GET {base_url}/sites/:site_id/theme_files/download

URL Parameters

Get specific theme file

GET {base_url}/sites/1/theme_files/2 returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "theme_files",
    "attributes" : {
      "etag": "ef8192015354713e9f98c3c0a2ec76ec",
      "path": "posts",
      "file_name": "show",
      "extension": "plate",
    },
    "relations" : {
      "site_id": 1,
    }
  }
}

This endpoint retrieves details about a specific theme file, but does not return the actual content of the theme file

HTTP Request

GET {base_url}/sites/:site_id/theme_files/:id

URL Parameters

Download specific theme file

This endpoint returns a specific theme file as a file.

HTTP Request

GET {base_url}/sites/:site_id/theme_files/:id/download

URL Parameters

Create theme file

An example of a valid HTTP request body, given the header Content-type: multipart/formdata; boundary: arandomuniquestring098123

--arandomuniquestring098123
Content-Disposition: form-data; name="path"


posts
--arandomuniquestring098123
Content-Disposition: form-data; name="file" filename="index.plate"
Content-Type: text/plain

... contents of the file 'index.plate' ...
--arandomuniquestring098123-

POST {base_url}/site/1/theme_files with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "theme_files",
    "attributes" : {
      "etag": "ef8192015354713e9f98c3c0a2ec76ec",
      "path": "posts",
      "file_name": "index",
      "extension": "plate",
    },
    "relations" : {
      "site_id": 1,
    }
  }
}

This endpoint is used to upload a new theme file. This endpoint expects a request with Content-type: multipart/form-data, boundary={boundary-key}, following the multipart/form-data principle as defined in RFC 7578 and shown in RFC 1867.

All POST parameters should also be sent according to the multipart principle, that is, each variable should have its own part in the request body. To the right an example of a valid HTTP request is shown.

HTTP Request

POST {base_url}/sites/:site_id/theme_files

URL Parameters

POST Parameters

Update theme file

An example of valid JSON PUT parameters

{
  "data": {    
    "path": "pages"
    "file_name": "_sidebar"
  }
}

PUT {base_url}/sites/1/theme_files/2 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "theme_files",
    "attributes" : {
      "etag": "ef8192015354713e9f98c3c0a2ec76ec",
      "path": "pages",
      "file_name": "_sidebar",
      "extension": "plate",
    },
    "relations" : {
      "site_id": 1,
    }
  }
}

This endpoint updates a theme file.

HTTP Request

PUT {base_url}/sites/:site_id/theme_files/:id

URL Parameters

PUT Parameters

Delete theme file

DELETE {base_url}/sites/1/theme_files/2 returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "theme_files",
    "attributes" : {
      "etag": "ef8192015354713e9f98c3c0a2ec76ec",
      "path": "pages",
      "file_name": "_sidebar",
      "extension": "plate",
    },
    "relations" : {
      "site_id": 1,
    }
  }
}

This endpoint deletes a specific theme file.

HTTP Request

DELETE {base_url}/sites/:site_id/theme_files/:id

URL Parameters

Attachment Folders

Get all attachment folders

GET {base_url}/sites/1/attachment_folders/ returns JSON structured like this:

{
  "data": [
    {
      "id": 3,
      "type": "attachment_folders",
      "attributes" : {
        "name": "Folder name 3"

      },
      "relations" : {
        "site_id": 1
      }
    },
    {
      "id": 3,
      "type": "attachment_folders",
      "attributes" : {
        "name": "Folder name 3"

      },
      "relations" : {
        "site_id": 1
      }
    }
  ]
}

This endpoint retrieves all attachment folders for a specific site

HTTP Request

GET {base_url}/sites/:site_id/attachment_folders

URL Parameters

Get specific attachment folder

GET {base_url}/attachment_folders/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "attachment_folders",
    "attributes" : {
      "name": "Folder name 3"

    },
    "relations" : {
      "site_id": 1
    }
  }
}

This endpoint retrieves a specific attachment folder.

HTTP Request

GET {base_url}/attachment_folders/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/attachment_folders/:id

Create attachment folder

An example of valid JSON POST parameters

{
  "data": {    
    "name": "Created Folder",
  }
}

POST {base_url}/sites/1/attachment_folders with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "attachment_folders",
    "attributes" : {
      "name": "Created Folder"        
    },
    "relations" : {
      "site_id": 1
    }
  }
}

This endpoint creates a attachment folder.

HTTP Request

POST {base_url}/sites/:site_id/attachment_folders

URL Parameters

POST Parameters

Update attachment folders

An example of valid JSON PUT parameters

{
  "data": {    
    "name": "A new foldername"
  }
}

PUT {base_url}/attachment_folders/3 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "attachment_folders",
    "attributes" : {
      "name": "A new foldername"        
    },
    "relations" : {
      "site_id": 1
    }
  }
}

This endpoint updates a site.

HTTP Request

PUT {base_url}/attachment_folders/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/sites/:site_id/attachment_folders/:id

Delete attachment folder

DELETE {base_url}/attachment_folders/1 returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "attachment_folders",
    "attributes" : {
      "name": "The deleted folder"        
    },
    "relations" : {
      "site_id": 1
    }
  }
}

This endpoint deletes a specific attachment folder.

HTTP Request

DELETE {base_url}/attachment_folders/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/sites/:site_id/attachment_folders/:id

Attachment

Get all attachments

GET {base_url}/sites/1/attachments/ returns JSON structured like this:

{
  "data": [
    {
      "id": 3,
      "type": "attachments",
      "attributes" : {
        "file_name": "some_image.jpg",
        "size": 12391,
        "title": "An image"
      },
      "relations" : {
        "site_id": 1,
        "attachment_folder_id": 2
      }
    },
    {
      "id": 4,
      "type": "attachments",
      "attributes" : {
        "file_name": "other_image.jpg",
        "size": 2002,
        "title": "Another image"
      },
      "relations" : {
        "site_id": 1,
        "attachment_folder_id": null
      }
    }
  ]
}

This endpoint retrieves all attachments for a specific site

HTTP Request

GET {base_url}/sites/:site_id/attachments

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/attachment_folder/:attachment_folder_id/attachments/ (Gives all attachments in an attachment folder)

Get specific attachment

GET {base_url}/sites/1/attachments/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "attachments",
    "attributes" : {
      "file_name": "some_image.jpg",
      "size": 12391,
      "title": "An image"
    },
    "relations" : {
      "site_id": 1,
      "attachment_folder_id": 2
    }
  }
}

This endpoint retrieves information about a specific attachment, but does not return the actual content of the attachment

HTTP Request

GET {base_url}/attachments/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/attachments/:id
• GET {base_url}/attachment_folders/:attachment_folder_id/attachments/:id

Download specific attachment

This endpoint returns a specific attachment as a file.

HTTP Request

GET {base_url}/attachments/:id/download

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/attachments/:id/download
• GET {base_url}/attachment_folders/:attachment_folder_id/attachments/:id/download

URL Parameters

Create attachment

An example of a valid HTTP request body, given the header Content-type: multipart/formdata; boundary: arandomuniquestring098123

--arandomuniquestring098123
Content-Disposition: form-data; name="title"

A title describing this attachment
--arandomuniquestring098123
Content-Disposition: form-data; name="file" filename="plate.png"
Content-Type: image/png

 ... contents of the file 'plate.png' ...
--arandomuniquestring098123-

POST {base_url}/site/1/attachments with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "attachments",
    "attributes" : {
      "file_name": "plate.png",
      "size": 12391,
      "title": "A title describing this attachment"
    },
    "relations" : {
      "site_id": 1,
      "attachment_folder_id": 2
    }
  }
}

This endpoint is used to upload a new attachment. This endpoint expects a request with Content-type: multipart/form-data, boundary={boundary-key}, following the multipart/form-data principle as defined in RFC 7578 and shown in RFC 1867.

All POST parameters should also be sent according to the multipart principle, that is, each variable should have its own part in the request body. To the right an example of a valid HTTP request is shown.

HTTP Request

POST {base_url}/sites/:site_id/attachments

URL Parameters

POST Parameters

Alternative endpoints

Alternative endpoints are:

• POST {base_url}/attachment_folders/:attachment_folder_id/attachments

Update attachments

An example of valid JSON PUT parameters

{
  "data": {
    "title": "A new attachment_title"
  }
}

PUT {base_url}/sites/1/attachments/5 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "attachments",
    "attributes" : {
      "file_name": "plate.png",
      "size": 12391,
      "title": "A new attachment_title"
    },
    "relations" : {
      "site_id": 1,
      "attachment_folder_id": 2
    }
  }
}

This endpoint updates an attachment.

HTTP Request

PUT {base_url}/attachments/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/attachment_folders/:attachment_folder_id/attachments/:id
• PUT {base_url}/sites/:site_id/attachments/:id

Delete attachment

DELETE {base_url}/sites/1/attachments/5 returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "attachments",
    "attributes" : {
      "file_name": "plate.png",
      "size": 12391,
      "title": "A new attachment_title"
    },
    "relations" : {
      "site_id": 1,
      "attachment_folder_id": 2
    }
  }
}

This endpoint deletes a specific attachment.

HTTP Request

DELETE {base_url}/attachments/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/attachment_folders/:attachment_folder_id/attachments/:id
• DELETE {base_url}/sites/:site_id/attachments/:id

Form Messages

Plate allows to receive form messages using the liquid form tag. These form messages can be retrieved using the following endpoints.

The response not only contains the content, the fields submitted in a form messages, but also sent_from_object which represent the content object that contains the form where the form message was sent from, and also the url of the page where the form was sent from, in sent_from_url.

Note that sent_from_object might be null if the object that contained the form no longer exists.

Get all form messages

GET {base_url}/sites/1/form_messages/ returns JSON structured like this:

{
  "data": [
    {
      "id": 2,
      "type": "form_messages",
      "attributes": {
        "content": {
          "form_field_1": "A filled in form field",
          "some_other_form_field": "an@example.email"
        },
        "sent_from_object": {
          "type": "elements",
          "id": 12
        },
        "sent_from_url": "/contact"
      },
      "relations": {
          "site_id": 1
      }
    },
    {
      "id": 3,
      "type": "form_messages",
      "attributes": {
        "content": {
          "form_field_1": "Another fill",
          "some_other_form_field": "my@sneaky.email"
        },
        "sent_from_object": null,
        "sent_from_url": "/contact"
      },
      "relations": {
          "site_id": 1
      }
    }
  ]
}

This endpoint retrieves all form messages for a specific site

HTTP Request

GET {base_url}/sites/:site_id/form_messages

URL Parameters

Get specific form message

GET {base_url}/form_messages/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "form_messages",
    "attributes": {
      "content": {
        "form_field_1": "A filled in form field",
        "some_other_form_field": "an@example.email"
      },
      "sent_from_object": {
        "type": "elements",
        "id": 12
      },
      "sent_from_url": "/contact"
    },
    "relations": {
        "site_id": 1
    }
  }
}

This endpoint retrieves a specific form message.

HTTP Request

GET {base_url}/form_messages/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/form_messages/:id

Delete form message

DELETE {base_url/form_messages/2 returns JSON structured like this:

{
  "data": {
    "id": 2,
    "type": "form_messages",
    "attributes": {
      "content": {
        "form_field_1": "A filled in form field",
        "some_other_form_field": "an@example.email"
      },
      "sent_from_object": {
        "type": "elements",
        "id": 12
      },
      "sent_from_url": "/contact"
    },
    "relations": {
        "site_id": 1
    }
  }
}

This endpoint deletes a specific form message.

HTTP Request

DELETE {base_url}/form_messages/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/sites/:site_id/form_messages/:id

Redirects

Get all redirects

GET {base_url}/posts/1/redirects/ returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "type": "redirects",
      "attributes": {
        "from_url": "/some_old/path/here"
      },
      "relations": {
        "post_id": 1
      }
    },
    {
      "id": 2,
      "type": "redirects",
      "attributes": {
        "from_url": "/some_other/path/there"
      },
      "relations": {
        "post_id": 1
      }
    }
  ]
}

This endpoint retrieves all redirects in a specific post.

HTTP Request

GET {base_url}/posts/:post_id/redirects

URL Parameters

Get specific Redirect

GET {base_url}/posts/1/redirects/1 returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "redirects",
    "attributes": {
      "from_url": "/some_old/path/here"
    },
    "relations": {
      "post_id": 1
    }
  }
}

This endpoint retrieves a specific redirect.

HTTP Request

GET {base_url}/redirects/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/posts/:post_id/redirects/:id

Create redirect

An example of valid JSON POST parameters

{
  "data": {    
    "from_url": "/an/old/path",
  }
}

POST {base_url}/posts/1/redirects with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "redirects",
    "attributes": {
      "from_url": "/an/old/path"
    },
    "relations": {
      "post_id": 1
    }
  }
}

This endpoint creates a redirect.

HTTP Request

POST {base_url}/posts/:post_id/redirects

URL Parameters

POST Parameters

Update redirect

An example of valid JSON PUT parameters

{
  "data": {    
    "from_url": "/a/new/path",
  }
}

PUT {base_url}/posts/1/redirects/1 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "redirects",
    "attributes": {
      "from_url": "/a/new/path"
    },
    "relations": {
      "post_id": 1
    }
  }
}

This endpoint updates a specific redirect.

HTTP Request

PUT {base_url}/redirects/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/posts/:post_id/redirects/:id

Delete redirect

DELETE {base_url}/posts/1/redirects/1 returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "redirects",
    "attributes": {
      "from_url": "/a/new/path"
    },
    "relations": {
      "post_id": 1
    }
  }
}

This endpoint deletes a specific redirect.

HTTP Request

DELETE {base_url}/redirects/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/posts/:post_id/redirects/:id

Site Translations

Get all site translations

GET {base_url}/sites/1/site_translations/ returns JSON structured like this:

{
  "data": [
    {
      "id": 3,
      "type": "site_translations",
      "attributes" : {
        "language": "nl",
        "content": {
          "content_field_1": {
            "value": [1032, 12, 1],
            "type": "reference",
            "subtype": "element",
            "content_field_id": 82
          },
          "content_field_2": {
            "value": "Go girl",
            "type": "text",
            "content_field_id": 83
          }
        }
      },
      "relations" : {
        "site_id": 1,
        "content_type_id": 16
      }
    },
    {
      "id": 2,
      "type": "site_translations",
      "attributes" : {
        "language": "en",
        "content": {
          "content_field_1": {
            "value": [1032, 123, 456],
            "type": "reference",
            "subtype": "element",
            "content_field_id": 82
          },
          "content_field_2": {
            "value": "A little text",
            "type": "text",
            "content_field_id": 83
          }
        }
      },
      "relations" : {
        "site_id": 1,
        "content_type_id": 16
      }
    }
  ]
}

This endpoint retrieves all site translations for a specific site

HTTP Request

GET {base_url}/sites/:site_id/site_translations

URL Parameters

Get specific site translations

GET {base_url}/sites/1/site_translations/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "site_translations",
    "attributes" : {
      "language": "nl",
      "content": {
        "content_field_1": {
          "value": [1032, 12, 1],
          "type": "reference",
          "subtype": "element",
          "content_field_id": 82
        },
        "content_field_2": {
          "value": "Go girl",
          "type": "text",
          "content_field_id": 83
        }
      }
    },
    "relations" : {
      "site_id": 1,
      "content_type_id": 16
    }
  }
}

This endpoint retrieves a specific site translation.

HTTP Request

GET {base_url}/site_translations/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/site_translations/:id

Update site translation

An example of valid JSON PUT parameters

{
  "data": {    
    "content_field_1": [
      {
        "id": 22,
      },
      {
        "id": 24,
        "reference_content_field_1": "Updated text for existing content_reference"
      },
      {
        "reference_content_field_1": "I am a referenced element",
        "reference_content_field_2": "Some text",

      }
    ],
    "content_field_2": "New text"
  }
}

PUT {base_url}/sites/1/site_translations/3 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "site_translations",
    "attributes" : {
      "language": "nl",
      "content": {
        "content_field_1": {
          "value": [22, 23, 1033],
          "type": "reference",
          "subtype": "element",
          "content_field_id": 82
        },
        "content_field_2": {
          "value": "New text",
          "type": "text",
          "content_field_id": 83
        }
      }
    },
    "relations" : {
      "site_id": 1,
      "content_type_id": 16
    }
  }
}

This endpoint updates a site translation.

HTTP Request

PUT {base_url}/site_translations/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/sites/:site_id/site_translations/:id

Posts

Get all posts

GET {base_url}/site_translations/1/posts?post_status=published returns JSON structured like this:

{
  "data": [
    {
      "id": 3,
      "type": "posts",
      "attributes" : {
        "title": "A Post title",
        "language": "nl",
        "post_status": "published",
        "content": {
          ...
        }
      },
      "relations" : {
        "site_translation_id": 1,
        "content_type_id": 14
      }
    },
    {
      "id": 4,
      "type": "posts",
      "attributes" : {
        "title": "Another Post title",
        "language": "nl",
        "post_status": "published",
        "content": {
          ...
        }
      },
      "relations" : {
        "site_translation_id": 1,
        "content_type_id": 14
      }
    },
  ]
}

This endpoint retrieves all posts for a specific site translation

HTTP Request

GET {base_url}/site_translations/:site_translation_id/posts[?post_status=...]

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/posts (Returns all posts in a site)

Get specific post

GET {base_url}/site_translations/1/posts/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "posts",
    "attributes" : {
      "title": "A Post title",
      "language": "nl",
      "post_status": "published",
      "content": {
        ...
      }
    },
    "relations" : {
      "site_translation_id": 1,
      "content_type_id": 14
    }
  }
}

This endpoint retrieves a specific post.

HTTP Request

GET {base_url}/posts/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• GET {base_url}/sites/:site_id/posts/:id
• GET {base_url}/site_translations/:site_translation_id/posts/:id

Create post

An example of valid JSON POST parameters

{
  "data": {
    "content_type_id": 14,
    "title": "Created Post",
    "post_status": "unpublished"
  }
}

POST {base_url}/site_translations/1/posts with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 5,
    "type": "posts",
    "attributes" : {
      "title": "Created Post",
      "language": "nl",
      "post_status": "unpublished",
      "content": {
        ...
      }
    },
    "relations" : {
      "site_translation_id": 1,
      "content_type_id": 14
    }
  }
}

This endpoint creates a post.

HTTP Request

POST {base_url}/site_translations/:site_translation_id/posts

URL Parameters

POST Parameters

Update post

An example of valid JSON PUT parameters

{
  "data": {
    "title": "An updated post title",
    "post_status": "published"
  }
}

PUT {base_url}/site_translations/1/posts/3 with the above parameters returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "posts",
    "attributes" : {
      "title": "An updated post title",
      "language": "nl",
      "post_status": "unpublished",
      "content": {
        ...
      }
    },
    "relations" : {
      "site_translation_id": 1,
      "content_type_id": 14
    }
  }
}

This endpoint updates a post.

HTTP Request

PUT {base_url}/posts/:id

URL Parameters

PUT Parameters

Alternative endpoints

Alternative endpoints are:

• PUT {base_url}/sites/:site_id/posts/:id
• PUT {base_url}/site_translations/:site_translation_id/posts/:id

Delete post

DELETE {base_url}/site_translations/1/posts/3 returns JSON structured like this:

{
  "data": {
    "id": 3,
    "type": "posts",
    "attributes" : {
      "title": "A Post title",
      "language": "nl",
      "post_status": "unpublished",
      "content": {
        ...
      }
    },
    "relations" : {
      "site_translation_id": 1,
      "content_type_id": 14
    }
  }
}

This endpoint deletes a specific post.

HTTP Request

DELETE {base_url}/posts/:id

URL Parameters

Alternative endpoints

Alternative endpoints are:

• DELETE {base_url}/sites/:site_id/posts/:id
• DELETE {base_url}/site_translations/:site_translation_id/posts/:id

Sections

Get all sections

GET {base_url}/posts/1/sections/ returns JSON structured like this:

{
  "data": [
    {
      "id": 3,
      "type": "sections",
      "attributes" : {
        "position": 1,
        "name": "A Section name",
        "content": {
          ...
        }
      },
      "relations" : {
        "post_id": 1,
        "content_type_id": 14
      }
    },
    {
      "id": 4,
      "type": "sections",
      "attributes" : {
        "position": 2,
        "name": "Another Section name",
        "content": {
          ...
        }
      },
      "relations" : {
        "post_id": 1,
        "content_type_id": 14
      }
    }
  ]
}