Evolving and Supporting the GraphQL API

Poppulo will continue to evolve the GraphQL API over time.

New APIs will be opened up to include other parts of the platform and existing APIs will be enhanced and improved.

A key aspect for maintaining and evolving the API is deprecating existing APIs. The following guide sets out the broad principles in relation to evolving the API and Poppulo's current deprecation approach.

Deprecation Approach

1. Poppulo will seek to avoid breaking changes where possible, while also evolving and improving the API for our customers.
2. Where deprecation is required the affected operation or fields will be marked up on the developer portal to indicate that the API is now deprecated.
3. Where an alternative or new API is provided as part of the deprecation this will be noted in the developer portal.
4. Typically, a 6-month notice of deprecation will be provided via the developer portal. Please allow sufficient time back from that date to update any affected integrations and deploy the updates to production.
5. Customer integrations will need to be maintained and updated as soon as possible to stop using the deprecated API.
6. The deprecation will have a deprecation date. After that date the operation or field can be removed without notice and will no longer be supported in the API at that point.

Early Access

To support integrations, Poppulo takes an API-First product-centric approach to developing features.

As a result there may be some cases where capabilities and features are available via the API before the full feature is fully available across the product.

For example, a new feature like multiple images related to content feed posts may be available before the content creation side in the Poppulo tool is updated in production to support multiple images end-to-end.

Our Commitment to Supporting Poppulo APIs

Poppulo understands the importance to our customers of both stable and updated APIs - and the impact to integrations related to API changes.

Enhancements to how Poppulo manages and communicates deprecations to the API will be made alongside the evolution of the APIs themselves.

Customer and developer feedback on the process is very welcome.