Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Hazards of Developers Evangelist for an API

DZone's Guide to

Hazards of Developers Evangelist for an API

· Integration Zone ·
Free Resource

SnapLogic is the leading self-service enterprise-grade integration platform. Download the 2018 GartnerMagic Quadrant for Enterprise iPaaS or play around on the platform, risk free, for 30 days.

I’m working to make it easier to get up and running using the Mimeo Connect Cloud Print API.

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:

3F2504E0-4F89-11D3-9A0C-0305E82C3301

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.

With SnapLogic’s integration platform you can save millions of dollars, increase integrator productivity by 5X, and reduce integration time to value by 90%. Sign up for our risk-free 30-day trial!

Topics:

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}