Skip to content

API Key

Назначение

Аутентификация через API-ключ. Ключ может быть отправлен как HTTP-заголовок или как параметр URL-запроса.

Когда использовать

  • Сервисы, использующие API-ключи
  • Погодные сервисы, геоданные, API перевода
  • Когда API ожидает ключ в заголовке (X-API-Key) или параметре запроса (?api_key=...)

Конфигурация

Ключ в заголовке

yaml
specs:
  - domain: jokes
    llm_title: Dad Joke API
    base_url: https://icanhazdadjoke.com
    collections:
      - llm_title: Jokes
        location: https://raw.githubusercontent.com/mmadfox/swag2mcp/main/specs/dadjoke.yaml
    auth:
      type: api-key
      config:
        key: "X-API-Key"
        in: header
        value: "$(API_KEY)"

Ключ в параметре запроса

yaml
specs:
  - domain: jokes
    llm_title: Dad Joke API
    base_url: https://icanhazdadjoke.com
    collections:
      - llm_title: Jokes
        location: https://raw.githubusercontent.com/mmadfox/swag2mcp/main/specs/dadjoke.yaml
    auth:
      type: api-key
      config:
        key: "api_key"
        in: query
        value: "$(API_KEY)"

Параметры

ПараметрОбязательноОписание
keyДаИмя заголовка или параметра запроса
inДаКуда поместить ключ: header или query
valueДаЗначение ключа (Поддерживает разрешение $(VAR))

Примечания

  • В режиме header ключ добавляется как HTTP-заголовок
  • В режиме query ключ добавляется как параметр URL
  • Значение value поддерживает разрешение $(VAR) из переменных окружения