1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
title: API Package Interfaces
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](https://godoc.org/github.com/ponzu-cms/ponzu/system/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`](/Interfaces/Editor#editormergeable)
interface, which will add "Approve" and "Reject" buttons to your Content types'
editor -- or implement [`api.Trustable`](#apitrustable) to bypass
the "Pending" section altogether and become "Public" immediately.
##### Method Set
```go
type Createable interface {
Create(http.ResponseWriter, *http.Request) error
}
```
##### Implementation
```go
func (p *Post) Create(res http.ResponseWriter, req *http.Request) error {
return nil
}
```
---
### [api.Updateable](https://godoc.org/github.com/ponzu-cms/ponzu/system/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
```go
type Updateable interface {
Update(http.ResponseWriter, *http.Request) error
}
```
##### Implementation
```go
func (p *Post) Update(res http.ResponseWriter, req *http.Request) error {
return nil
}
```
---
### [api.Deleteable](https://godoc.org/github.com/ponzu-cms/ponzu/system/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
```go
type Deleteable interface {
Delete(http.ResponseWriter, *http.Request) error
}
```
##### Implementation
```go
func (p *Post) Delete(res http.ResponseWriter, req *http.Request) error {
return nil
}
```
---
### [api.Trustable](https://godoc.org/github.com/ponzu-cms/ponzu/system/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.
```go
type Trustable interface {
AutoApprove(http.ResponseWriter, *http.Request) error
}
```
##### Implementation
```go
func (p *Post) AutoApprove(res http.ResponseWriter, req *http.Request) error {
return nil
}
```
|
