API

Ponzu provides a set of interfaces from the system/api package which enable richer interaction with your system from external clients. If you need to allow 3rd-party apps to manage content, use the following interfaces.

The API interfaces adhere to a common function signature, expecting an http.ResponseWriter and *http.Request as arguments and returning an error. This provides Ponzu developers with full control over the request/response life-cycle.

---

Interfaces

api.Createable

Externalable enables 3rd-party clients (outside the CMS) to send content via a multipart/form-data encoded POST request to a specific endpoint: /api/content/create?type=<Type>. When api.Createable is implemented, content will be saved from the request in a "Pending" section which will is visible only within the CMS.

To work with "Pending" data, implement the editor.Mergeable interface, which will add "Approve" and "Reject" buttons to your Content types' editor -- or implement api.Trustable to bypass the "Pending" section altogether and become "Public" immediately.

Method Set

type Createable interface {
    Create(http.ResponseWriter, *http.Request) error
}

Implementation

func (p *Post) Create(res http.ResponseWriter, req *http.Request) error {
    return nil
}

---

api.Updateable

Updateable enables 3rd-party clients (outside the CMS) to update existing content via a multipart/form-data encoded POST request to a specific endpoint: /api/content/update?type=<Type>&id=<id>. Request validation should be employed otherwise any client could change data in your database.

Method Set

type Updateable interface {
    Update(http.ResponseWriter, *http.Request) error
}

Implementation

func (p *Post) Update(res http.ResponseWriter, req *http.Request) error {
    return nil
}

---

api.Deleteable

Updateable enables 3rd-party clients (outside the CMS) to delete existing content via a multipart/form-data encoded POST request to a specific endpoint: /api/content/delete?type=<Type>&id=<id>. Request validation should be employed otherwise any client could delete data from your database.

Method Set

type Deleteable interface {
    Delete(http.ResponseWriter, *http.Request) error
}

Implementation

func (p *Post) Delete(res http.ResponseWriter, req *http.Request) error {
    return nil
}

---

api.Trustable

Trustable provides a way for submitted content (via api.Createable) to bypass the editor.Mergeable step in which CMS end-users must manually click the "Approve" button in order for content to be put in the "Public" section and access via the content API endpoints. api.Trustable has a single method: AutoApprove which will automatically approve content, bypassing the "Pending" section altogether.

type Trustable interface {
    AutoApprove(http.ResponseWriter, *http.Request) error
}

Implementation

func (p *Post) AutoApprove(res http.ResponseWriter, req *http.Request) error {
    return nil
}