Hazards of Developers Evangelist for an API
Join the DZone community and get the full member experience.Join For Free
One concept that is tough to understand at first, is that all printing starts with a Mimeo document.
Then using the API you can either order that document as is, or merge one or many PDF documents with it, generate a dynamic document, then order this new document.
As part of our API, we have a Document Listing Service, except it only pulls documents from a central account I have control of.
So if you want to pull one of the documents you created, you have to actually pull the Document ID from your My Mimeo account.
Sounds easy right? Well its available in the URL, and in a properties screen for the document.
The Document ID is a GUID, for those of you who don’t know what a GUID is:
A globally unique identifier or GUID (pronounced /ˈɡuːɪd/ or /ˈɡwɪd/) is a unique reference number used as an identifier in computer software
So a Document ID looks like this:
Except for some reason the one that shows in My Mimeo is missing the dashes, and doesn’t work when you pass through the API.
So I ask my API developer, where is the easiest place to get the Document ID?
He says, “In the URL or as property of document”.
I explain it doesn’t work without dashes.
His response is, “Developers will understand, and know to put dashes back in”.
And that is a hazard of putting developers as the public face of your API.
They make a lot of assumptions based upon what they know.
API Evangelists and developer advocates should definitely have programming skills, but ideally they should have a balance of proramming, business and marketing skills.
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.