API Key Usage

API Key Usage

Все взаимодействие с FraudHosting строится вокруг персонального _api ключа. Ниже приведены рекомендации по его получению, хранению и использованию.

Получение ключа

  1. Войдите в панель FraudHosting.
  2. Откройте раздел Reporter Profiles.
  3. Создайте профиль (если его ещё нет) и скопируйте значение поля API Code — это строка из 16 шестнадцатеричных символов.

Ключ выдаётся один раз на профиль и не обновляется автоматически. При утечке ключ нужно отозвать в панели и выпустить новый.

Практика хранения

  • Никогда не пишите ключ в репозиторий. Сохраняйте его в переменных окружения или менеджере секретов.
  • Используйте отдельные ключи для продакшена и тестовой среды.
  • Периодически просматривайте историю использования в панели и удаляйте неактуальные профили.

Базовый шаблон запроса

Команда определяется параметром _action, а _api присутствует всегда:

_api=<ваш_ключ>&_action=<report|query|delete>&...
$apiKey = getenv('FRAUDHOSTING_API'); // храните ключ вне кода

$basePayload = [
  '_api'    => $apiKey,
  '_action' => 'query',
];
import os

API_KEY = os.environ["FRAUDHOSTING_API"]

payload = {
  "_api": API_KEY,
  "_action": "report",
}
#include <cstdlib>
#include <map>
#include <string>

std::string apiKey = std::getenv("FRAUDHOSTING_API");

std::map<std::string, std::string> payload{
  {"_api", apiKey},
  {"_action", "delete"},
};
package auth

import "os"

var APIKey = os.Getenv("FRAUDHOSTING_API")

func BaseParams(action string) map[string]string {
	return map[string]string{
		"_api":    APIKey,
		"_action": action,
	}
}

Проверка и мониторинг

Перед включением в боевой процесс отправьте тестовый запрос в «песочницу», используя выдуманные данные. FraudHosting запрещает публиковать реальные клиентские данные во время тестов — даже в захэшированном виде.

Если API перестал принимать запросы, проверьте:

  • не отозван ли ключ в панели;
  • корректно ли сформированы параметры (_api должен присутствовать первым, но порядок остальных не важен);
  • не исчерпан ли лимит запросов (при интенсивной активности сделайте паузы и повторите попытку).