Effectively Documenting APIs and SDKs


August 10, 2022 - 12:00 PM


Effectively Documenting APIs and SDKs

Wednesday, 10 August 2022; 12 Noon to 1:00 PM Eastern time (GMT-4)

People often use Application Programming Interfaces (APIs) and Software Development Kits (SDKs)  interchangeably. However, they are conceptually different. Join Girish Sankaran as he reviews some best practices for documenting any API from scratch regardless of the API type. You will learn what does and does not need to be included in API documentation.

A SDK generally includes client programs to call the API, documentation to set up the prerequisites, and instructions to compile and run the client program. SDKs include many client programs to meet the developers’ common use cases that may require multiple programming languages. Essentially, with an SDK, developers can consume an API in minutes, whereas it might take hours or even days for a developer to start without an SDK.

Attendee takeaways from this webinar include:

  • The clear differences and similarities between APIs and SDKs.
  • APIs are of different types: REST APIs, SOAP-based APIs, and standalone APIs that are neither SOAP- nor REST-based. Regardless of the API type, you can follow some best practices for documenting any API from scratch. You must know what needs to be included and what does not need to be included in the documentation.
  • Learn that what goes into an SDK document ultimately defines the effectiveness of the software to meet customer expectations and create a satisfactory user experience. You’ll come away knowing the nuts and bolts of various SDK components and how you can represent these components in your SDK documents for easy developer consumption.

For current CPTC certificants: This webinar provides 2 CEUs for recertification, in the Production Delivery core compentency area.

Frequently Asked Questions

When do education events take place?

Webinars are held on a variety of days. The times are always published as Eastern time (GMT-5/-4)

A majority of online courses are held at times as to not conflict with webinar times.

When will I receive the GoTo Webinar/GoTo Meeting instructions for an event?

Registered attendees for webinars will receive the GoTo Webinar instructions shortly after they have completed the registration. An email will be sent from “STC Education Department”.

Registered attendees for online course will receive the logon instructions for the live sessions and learning management site at least one (1) day before the online course begins.

To participate in a webinar and an online course, you must be able to access GoTo Webinar or GoTo Meeting, STC's online meeting space. Check system requirements for GoTo Webinar and GoTo Meeting prior to joining. GoTo Webinar and GoTo Meeting are a standard web seminar tool (no separate download required) and all you need is a reliable Internet connection and phone line, or a computer with VoIP capabilities.

I registered for an online course, what are my next steps?

Once you register for an online course, you will receive a confirmation receipt that day. Attendees will receive the login instructions for STC's learning management site at least one (1) days before the course begins.

I registered for a webinar, but will be unable to attend. Will a recording be available?

All webinar registered attendees receive an email with a link to the recording, and an evaluation link following the webinar.

I registered for an online course, but cannot attend at that time. Will I receive a refund?

If you are unable to attend the live sessions for an online course, the instructor may allow you to view the recordings of the sessions as an alternative. If you decide you want to cancel your registration you must do this prior to the second session. You will receive a refund, minus a $75 administrative fee. STC will also consider transferring your registration fee to another online course. This option is available only for courses in the same calendar year.

I want to take a specific course that isn't listed online. Will it be offered in the future?

STC rotates its courses every year as we try to offer the most popular ones within the first half of the year. Online courses are subject to change or are offered more than once per quarter. If a course is not listed, STC may offer it again in the following year.

Have an Education Question? Contact Us!