Authenticate.
Browser sessions support people. Party API keys support authorized reader systems. A key’s scope and reading tier constrain the material it can retrieve.
Programmatic access
Published documents.
Available to your systems, too.
Authorized readers can retrieve a package index and its permitted files over HTTPS. File records include SHA-256 hashes for verification.
Read the index.
Retrieve the published package index to discover the available file paths, access tiers and hashes. Unpublished working material is separate.
Fetch and verify.
Retrieve a permitted file and compare its SHA-256 hash with the index. File access is recorded in the trust center’s activity log.
The service’s own contract
Use the current OpenAPI document.
Route paths, parameters and authentication requirements are documented by the service. Start there when integrating with a particular deployment.
Open the API specificationOwners publish from the hosted application. Customers do not need repositories, a compiler or command-line tools to use RampGuide.