A Structured Approach to an
Unstructured Problem
Communicating APIs to Non-Techies
Joseph Mosby
APCO Worldwide
@josephmosby
Explain Structured Data
Text of Poe's The Raven
<xml>
<poem>
<stanza>
<line>Once upon a midnight dreary, while I pondered, weak and weary,</line>
<line>Over many a quaint and curious volume of forgotten lore--</line>
...
</stanza>
</poem>
</xml>
Explain Structured Data
OCsNzmwm/Uzxh/6r`LgW!
v&&|2BB)7}vhVq.!Agw^g)@
2j{xjzey*|lY;.2!F(........
<xml>
<poem>
<stanza>
<line>Once upon a midnight dreary, while I pondered, weak and weary,</line>
<line>Over many a quaint and curious volume of forgotten lore--</line>
...
</stanza>
</poem>
</xml>
Start With Queries
GET www.poe.com/api/poems/raven
V
<xml><poem><stanza><line>Once upon a midnight dreary, while I pondered, weak and weary,</line>........
Draw It Out
Successful interaction of user with API
Draw It Out
User fails to authenticate against API
API call is not appropriate
Make It Real
Dominos Status Tracker
Respect the Customer
Information does not necessarily "want" to be free.

These slides are on Github.

josephmosby.github.io/presentations/dc_api/index.html

/

#