Example.com TypeScript SDK

Overview

This is an example API to demonstrate features of the OpenAPI specification. # Introduction This API definition is intended to to be a good starting point for describing your API in OpenAPI/Swagger format. It also demonstrates features of the create-openapi-repo tool and the Redoc documentation engine. Beyond the standard OpenAPI syntax, we use a few vendor extensions. # OpenAPI Specification The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.

Installation

npm install @test-sdk-123/sdk-typescript --save

Configuration

import { Configuration, BrandsApi } from '@test-sdk-123/sdk-typescript';

// Create configuration with API key
const config = new Configuration({
  headers: {
    'api-key': 'your_api_key_here'
  }
});

// Create API client
const api = new BrandsApi(config);

Example Request

// Get brand data by domain
const response = await api.byDomain({
  domainRequest: {
    domain: 'example.com'
  }
});

// Access brand data
console.log('Brand:', response.brand.name);
console.log('Logo:', response.images.logos[0].url);
console.log('Primary Color:', response.colors.primary[0].hex);

API Endpoints

Models

List of available API Models

Example.com Models

Authentication

Authentication schemes defined for the API:

Example.com Authentication Documentation

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header