Skip to content

Commit b750c97

Browse files
author
stephen powis
committed
update readme
1 parent d965cf5 commit b750c97

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,20 @@ Official Documentation: [Users](http://developer.pardot.com/kb/api-version-3/use
118118

119119
## How to Contribute
120120

121-
More information soon.
121+
Want to help implement the missing API end points? Fork the repository, write some code, and
122+
submit a PR to the project!
123+
124+
Implementing new API requests really only requires implementing the two following interfaces, along with
125+
minimal glue code.
126+
127+
### [Request](/blob/master/src/main/java/com/darksci/pardot/api/request/Request.java)
128+
The Request interface can typically be implemented by extending either [BaseRequest](/blob/master/src/main/java/com/darksci/pardot/api/request/BaseRequest.java) or [BaseQueryRequest](/blob/master/src/main/java/com/darksci/pardot/api/request/BaseQueryRequest.java).
129+
This defines the end point that the request will hit, along with what parameters will be
130+
passed along with it.
131+
132+
### [ResponseParser](/blob/master/src/main/java/com/darksci/pardot/api/parser/ResponseParser.java)
133+
The ResponseParser interface defines how to take the API's response and convert it back into
134+
user friendly Plain Old Java Objects (POJOs).
122135

123136
## Changelog
124137

0 commit comments

Comments
 (0)