Sorry, you need to enable JavaScript to visit this website.

You are here

Good APIs start with the docs

BY Michelle Howie 20 December 2021

With our new docs experience, it's easier than ever to get started with Telstra APIs. 

 

What’s all the fuss about?

We're on a mission to create a better developer experience. We appreciate that developers are building the world we live in, and so we've reworked our new API and IoT offerings to suit their unique needs. And we’ve started at the core: uplifting the docs experience.

We realise that devs get frustrated, or abandon APIs, if documentation is missing info or difficult to follow. It’s a big blocker when you have to reach out for help with simple things like decoding a cryptic error response code, or validating a use case. And what’s the point of a community maintaining brilliant SDKs and Postman Collections if they can’t easily be found?

Our new experience has a clearly articulated product overview that makes it easy to pick the perfect APIs to fit your use case. Plus, our API tutorials and reference documentation now have code examples in multiple languages to help you get to the first Hello World and beyond.

Telstra Messaging API docs

The Telstra Messaging API documentation is the first to be released in this new overview format. Read all about the benefits of our enterprise-grade API and take advantage of extended tutorials for must-have features such as how to automate two-way SMS conversations. Our refreshed API documentation is designed to be easy to use and follow, with detailed guidance on how to use the API over REST, as well as directly from code via our Software Development Kits (SDKs). 

Improved error messaging

We’ve also learnt from our customers’ pain points and extended the error response instructions for all API endpoints. This has already helped developers power through late night coding sessions without having to wait for us (although the community forums are always there if needed). Our support team is also taking note of these common errors and putting in longer term fixes in the coming Messaging API V3 release.

Give us your feedback

Did you notice the new feedback elements on the portal? Over the coming months, we’re keen to work with you to learn how the documentation and other key experiences can be improved. Use the new star ratings, thumbs up/down and comments function to let us know what you find useful, and what we can do better. Your suggestions might be part of our next release. You can also reach out to us at any time by emailing telstradev@team.telstra.com

What else is new in 2021?

This year we: 

•    Updated SDKs for Node.js and Python
•    Grew our dedicated onshore technical support team with a focus on developer specific needs
•    Implemented a Code of Conduct to strengthen our community 
•    Added automatic approval for posts and comments on our forums so devs can help each other quicker, at any time
•    Extended Messaging API Tutorials
•    Released the IoT Connectivity Manager API to monitor your Internet of Things SIM
•    Stopped selling the Arduino IoT developer kits and closed the IoT marketplace, to focus on our core APIs
•    Worked to make the world a better place at various hackathons like GovHack (IoT Insights for Sustainable Regional Agribusiness), Call for Code (Zero Hunger) and Uni Hack 
•    Launched a Discord server for the AusIoT community to collaborate between monthly meet-ups
•    Hosted AgTech, Cyber, ETSI IoT standards, Energy, Space, DevOps, Arduino and home projects themed AusIoT meetups in Adelaide, Brisbane and online! Catch the replays on our AusIoT YouTube

If you want to know more about Telstra's renewed focus on Developer Experience, check out our presentations with Q&A at the Telco Application Developer Asia Summit 2021 and API Days Australia 2021.

What have we got to look forward to?

•    Clearer pricing pages
•    Easier and more secure ways to find and manage API keys 
•    Smoother onboarding
•    New APIs (Messaging v3, Connected Supply Chain and more! Have a request for Telstra's next public API? Let us know here)
•    More detailed API usage logs
•    Dashboard and reporting improvements, to help customers better understand and improve their use of our products

What are we missing? Post your suggestion in our public developer forums, or through the anomymous feedback widgets on our site and we'll look into it.

Happy coding!

William Fettke, Telstra API and Developer Experience Product Owner,

Vinodh Seshadri, Telstra's Developer Support Lead, and

Michelle Howie, Telstra's Developer Advocate

Related Blogs

anonymous's picture

By Daniel Simpson

17/12/21

  • azure
  • microsoft

A code-first approach to digital twins

Find out how to use code-first digital twins with the Telstra Digital Twins library.   ...
anonymous's picture

By Michelle Howie

15/7/21

  • arduino
  • iot

Trigger an SMS alert when a device is dropped

Learn how Arduino can be used to trigger an SMS alert when a device has been dropped.  Autom...
anonymous's picture

By Michelle Howie

15/7/21

  • arduino
  • iot

Use SMS to control your IoT device

In this blog, we look at how to use SMS commands from the Telstra Messaging API to control your IoT...
anonymous's picture

By Tim McMahon

2/6/21

  • Telstra Messaging API
  • bushfire

Air quality SMS alerts during bushfire season

I woke up one morning in January 2020 to discover that the air quality in Melbourne had dropped...
anonymous's picture

By Alan Quayle

18/5/21

  • iot
  • REST API

Unlocking the IoT: Telstra Track and Monitor API

As Australia’s longest serving telco, Telstra is expanding their developer program to provide...
anonymous's picture

By Michelle Howie

23/12/20

  • TDev
  • documentation

TelstraDev End of Year Wrap: 2020

We made it! Welcome to the end of 2020, may it soon be just a distant memory. Though it wasn’t...
anonymous's picture

By Michelle Howie

20/10/20

  • hackathon
  • Telstra Messaging API

GovHack 2020: emergency comms with the Telstra Messaging API

What do you get when you give 700 hackers, hustlers and hipsters across Australia and New Zealand, a...
anonymous's picture

By Michelle Howie

1/9/20

  • iot
  • developer experience

IoT guidelines for wireless developers

The Internet of Things (IoT) is an all-encompassing suite of technologies, with dozens of options fo...
anonymous's picture

By Michelle Howie

7/7/20

  • developer experience
  • REST API

New Developer Feature: API Service Status Page

You asked, we listened. Our developer community told us that they wantedgreater transparency and...
anonymous's picture

By Michelle Howie

25/5/20

  • developer experience
  • REST API

Getting virtual in times of uncertainty

Here at TelstraDev, we hope you're continuing to thrive and innovate, staying safe and healthy i...
anonymous's picture

By DeveloperSteve Coochin

11/1/18

  • REST API
  • Telstra Messaging API

Welcoming in the New Year

Happy New year, I hope you had an awesome break and were able to recharge, reset and prepare for...