API Management

Whether you are publishing your first API or managing a growing catalog, these guides walk you through the full API lifecycle on the PSA Developer Portal. Each guide is task-focused, with clear steps, examples, and checklists you can follow along with.

Good API management starts with a consistent approach: describe every API with an OpenAPI specification, publish it with predictable versioning, and keep documentation current as the API evolves. The guides below cover each of these practices.

Where to start

• Document APIs – Write clear, complete API documentation using OpenAPI, including descriptions, examples, and error responses, so developers can integrate with confidence.
• Publish APIs – Make your APIs discoverable by publishing them to the portal, controlling visibility, and managing versions and changes over time.
• Versioning – Introduce breaking changes safely with a clear versioning and deprecation policy.

Before you begin

• Request access to the portal and confirm you can sign in.
• Have your API's OpenAPI specification (3.0 or 3.1) ready in JSON or YAML.
• Review the Getting started page to register an application and obtain credentials.

Need help?

If you can't find what you're looking for, browse the APIs catalog to see working examples, or contact the API platform team for support.