OpenAPI Specification

The Swypex Partner API OpenAPI specification provides a machine-readable description of our API endpoints, request/response schemas, and authentication requirements. These files can be used with various tools and frameworks to generate client libraries, test your integration, or import into API development tools.

Available Versions

We provide OpenAPI specifications in two versions to ensure compatibility with different tools and workflows. Both specifications describe the same API and will work for integrating with the Swypex Partner API.

OpenAPI 3.1.0

The latest OpenAPI specification format with enhanced JSON Schema compatibility and improved expressiveness.

OpenAPI 3.0.0

The widely-supported OpenAPI 3.0.0 format, compatible with most API tools and code generators.

Using the Specification

Once downloaded, you can use these OpenAPI specification files with various tools:

• Code Generation: Generate client libraries in your preferred programming language using tools like OpenAPI Generator or Swagger Codegen
• API Testing: Import into testing tools like Postman, Insomnia, or Hoppscotch
• Documentation: Generate interactive API documentation using Swagger UI or ReDoc
• Validation: Validate your API requests and responses against the specification using Spectral or similar tools