Testing guidelines for public APIs

This document outlines the testing guidelines for public APIs to ensure they meet quality standards before deployment.

Testing api on non-prod

Test all new and existing API endpoints on your specification after deployment to non-prod environment. If you do not know the non-prod url for your API, then prepare it using the following pattern.

Non-prod base url: https://api.seismic-dev.com/{your-route}

How to get the token for authentication

Use the get-a-token site - https://cdn-prod.seismic.com/static/public/getatoken/index.html

If your API requires specific scopes which is not available on the site, then contact #help-api-dev-and-docs for assistance or create a PR here - https://github.com/seismic/get-a-token/blob/8a62e462ab3bf8b6818d80c47e3dae327235dd5a/pages/getatoken.js#L80

Testing the documentation on staging

CI will publish the documentation on staging developer portal. Use the following base url to test the documentation.

Staging base url: https://seismicsoftware-staging2.readme.io/v3.0-RELPACE_WITH_PR_ID

The password for this url is stored in 1password. Use the following link to get the password.
https://start.1password.com/open/i?a=4HF4SVA3NFCWDGEFPQ3YQTTIRQ&h=seismic-software.1password.com&i=swypvynrzn2nznmahket4czhom&v=6qw23gbwdqafw7dcrkq6p4bg4a

alt text

Note: The Try It feature will not work on staging with non-prod api.