DZone
Integration Zone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
  • Refcardz
  • Trend Reports
  • Webinars
  • Zones
  • |
    • Agile
    • AI
    • Big Data
    • Cloud
    • Database
    • DevOps
    • Integration
    • IoT
    • Java
    • Microservices
    • Open Source
    • Performance
    • Security
    • Web Dev
DZone > Integration Zone > Constant Contact Provides a Good Blueprint for an API Getting Started Page

Constant Contact Provides a Good Blueprint for an API Getting Started Page

When it comes to getting users to hit the ground running with your API, it's hard to do better than Constant Contact. See what elements ought to go into a good page.

Kin Lane user avatar by
Kin Lane
·
Aug. 20, 16 · Integration Zone · Opinion
Like (1)
Save
Tweet
3.30K Views

Join the DZone community and get the full member experience.

Join For Free


I was going through the getting started pages for the APIs that I keep an eye on, pulling together an outline of what I'd consider to be some of the best elements across all the API providers. Then I came across the getting started page from Constant Contact, and I'd say they win for being the clearest and most concise API getting started page of them all. 

Constant Contact's approach to their getting started page has given me a good start for my outline, including essential links to set up your account, create a new application, and get your keys. Constant Contact also provides required documentation, an API tester, and supporting code libraries. Additionally, they encourage you to certify your integration as a partner and get published in their integration marketplace — providing a pretty well thought out getting started page in my opinion.

I am going to take what I've learned here and craft a sample getting started page for my minimum viable API portal definition. I'm sure some of you are snickering at me paying attention to API operations at this level of detail, but I wouldn't underestimate the ability of a well-crafted API getting started page to reduce friction with developers. I want to give API providers with a simple template they can follow when publishing a getting started page.

With the next release of my API portal, I'll have a good example of a getting started page, which will be heavily influenced by Constant Contactt.

API Contacts (Apple)

Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Roles in Data Science Teams
  • You Are Blind to the Risks in Your Cloud — Why Companies Need Cloud Security Monitoring
  • Tools and Integrations to Significantly Improve Code Review in GitHub
  • IntelliJ Integration for Mockito

Comments

Integration Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • MVB Program
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends:

DZone.com is powered by 

AnswerHub logo