Documentation

How we tell you.

We are proud of our extensive documentation. It has been written to provide information on not only what makes a well designed API, but also why the recommendation is most suitable. This means that designers, developers and consumers alike are better able to apply their knowledge to future projects.

All the documentation’s examples are automatically customisable with company specific Urls, enabling working integrations using simple cut and paste. Written in Markdown and available for hosting On-Premise using a single Docker image or via the Tennant documentation for Cloud.

A snippet from our documentation

Below is the index, demonstrating how many topics influence API Design and Consumption, but also how these are broken down into topics to enable quick reference.

APInfinity:

  • Overview
  • API Economy & Apinfinity
  • Core:
    • OAS driven proxy automation
    • Naming conventions
    • Standard Headers
    • CORS
    • Governance enforcement
    • Client Management
  • Proxies:
    • Overview
    • DNS Router
    • Webhooks
    • OAuth
    • OAuth Cookie
  • Supporting Services:
    • Overview
    • Resource Usage
    • Specification Compliance
    • Operations
    • Mocks
    • Binary Integrity

API Producer:

  • Overview
  • Taxonomy:
    • APIs & Endpoints
  • Producer’s Checklist
  • Functional Design:
    • Design Guidelines
    • HTTP Methods
    • Metadata
    • Convenience Endpoints
    • Versioning
  • Technical Design:
    • RESTful Design
    • Paths, Headers, Query & Payload
    • Resource Collections
    • Batch Processing
    • Dates & Times
    • Notifications
    • Scopes & Security
    • Implementation considerations
    • GraphQL
  • Environment availability
  • Sandbox Environment
  • SLA:
    • Overview
    • Open SLA
  • Gateway Protection
  • Southbound Headers
  • Advanced Topics:
    • Additional Endpoints
    • Perceived Slowness
    • CORS
    • Northbound & Southbound
    • Caller Security
    • Compression
    • HTTP Caching
    • Binary Threat protection
    • Token introspection
    • PUT & POST Filtering
    • Penetration testing
  • OAS Authoring:
    • Overview
    • Conventions
    • Encoding
    • Versioning
    • ID Design
    • Character suitability
    • Resource Collections
    • Content Types
    • Response Status Codes
    • Cache Headers
    • Data Compression
    • Metadata
    • Security

API Consumer:

  • Overview
  • Consumer’s Checklist
  • Development Tools
  • On Boarding
  • Authentication & Authorisation:
    • Overview
    • Client Credentials
    • Authorization Code
    • PKCE Authorization Code
    • Implicit
    • Browserless Authentication
  • Standard headers
  • Responding to HTTP Status Codes
  • Browsers & CORS
  • Northbound 2-Way TLS