Working With The API Documentation Within Your Own Digital Workplace
We're making some minor changes to the documentation in Customer Care
When we updated our developer documentation using SwaggerUI the feedback was overwhelmingly positive. Moving to the OpenAPI standard meant that most developers would feel right at home with our API documentation.
However, in our next release, we will be disabling the ‘try it now’ feature on the API documentation that lives in the Customer Care site. The ‘Try It Now’ feature relies on your account’s credentials and as a result, not many users on Customer Care have sufficient privileges to use most of the API. The API reference will still be available, but the ability to 'try' the API out within Customer Care is being disabled.
Not to worry though - Swagger UI can also be made available in your own digital workplace! Here’s how to get access to them:
- If you haven’t already, your first step is to sign up for The Developer Program.
- Submit a ticket to firstname.lastname@example.org to enable The Developer Documentation within your site.
- That’s it. You’ll have full access to the SwaggerUI docs, which includes the “Try It Now” feature.