Laravel Guide for Fraud Buster API Integration

Fraud Buster API Integration in Laravel

Overview

Welcome to the Laravel guide for integrating Hive Forensics AI’s Fraud Buster API. This guide provides step-by-step instructions to help you securely connect and interact with our fraud detection service in your Laravel application.

Prerequisites

Before starting, ensure you have the following:

PHP 8.0+ and Composer installed.
A working Laravel project (or follow the steps below to create one).
Basic knowledge of Laravel framework and HTTP clients.
An API key provided by Hive Forensics AI.
A code editor (e.g., VSCode).

Setup Instructions

Step 1: Create a Laravel Project

If you don’t have a Laravel project, create one using Composer:

composer create-project --prefer-dist laravel/laravel fraud-buster-demo
cd fraud-buster-demo

Step 2: Install Guzzle HTTP Client

Laravel includes Guzzle HTTP Client, which we’ll use to make API requests. If it’s not already installed, add it via Composer:

composer require guzzlehttp/guzzle

Step 3: Configure Environment Variables

Add the Fraud Buster API URL and API key to the .env file in your project root:

FRAUD_BUSTER_URL=http://localhost:8000/api/transaction
FRAUD_BUSTER_API_KEY=your-api-key-here

Update your config/services.php file to include the Fraud Buster API configuration:

return [
    // Other services...

    'fraud_buster' => [
        'base_uri' => env('FRAUD_BUSTER_URL'),
        'api_key' => env('FRAUD_BUSTER_API_KEY'),
    ],
];

Usage Instructions

Step 4: Create an API Service Class

Create a dedicated service to handle API interactions:

php artisan make:service FraudBusterService

FraudBusterService.php

<?php

namespace App\Services;

use Illuminate\Support\Facades\Http;

class FraudBusterService
{
    protected $baseUrl;
    protected $apiKey;

    public function __construct()
    {
        $this->baseUrl = config('services.fraud_buster.base_uri');
        $this->apiKey = config('services.fraud_buster.api_key');
    }

    public function evaluateTransaction(array $data)
    {
        $response = Http::withHeaders([
            'Content-Type' => 'application/json',
            'x-api-key' => $this->apiKey,
        ])->post($this->baseUrl, $data);

        if ($response->successful()) {
            return $response->json();
        }

        throw new \Exception('Fraud Buster API request failed: ' . $response->body());
    }
}

Step 5: Create a Route and Controller

Generate a controller for handling API calls:

php artisan make:controller FraudBusterController

Update the FraudBusterController.php file:

<?php

namespace App\Http\Controllers;

use App\Services\FraudBusterService;
use Illuminate\Http\Request;

class FraudBusterController extends Controller
{
    protected $fraudBuster;

    public function __construct(FraudBusterService $fraudBuster)
    {
        $this->fraudBuster = $fraudBuster;
    }

    public function checkTransaction(Request $request)
    {
        try {
            $transactionData = $request->all();
            $response = $this->fraudBuster->evaluateTransaction($transactionData);
            return response()->json($response);
        } catch (\Exception $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }
}

Step 6: Define Routes

Add the following route in routes/web.php:

use App\Http\Controllers\FraudBusterController;

Route::post('/api/check-transaction', [FraudBusterController::class, 'checkTransaction']);

Step 7: Test the API Integration

Start the Laravel development server:

php artisan serve

Use Postman or cURL to test the endpoint:

curl --location 'http://localhost:8000/api/check-transaction' \
--header 'Content-Type: application/json' \
--data-raw '{
  "product": "Rolex Watch",
  "amount": 9500,
  "location": "Florida",
  "time": "2024-03-04T10:30:00Z",
  "customerProfile": "Tech Enthusiast",
  "onlinePurchase": true,
  "paymentMethod": "Amex",
  "shippingAddress": "PO BOX 8877 Los Angeles CA 90210",
  "billingAddress": "18803 SW 92 Ave Miami Florida 33157",
  "customerEmail": "sam@protonmail.com",
  "customerName": "Steven Smith",
  "isVPN": false,
  "clientBrowser": "Chrome",
  "deviceType": "Desktop",
  "ipAddress": "352.168.1.186",
  "deviceFingerprint": "abcd1234efgh5678",
  "transactionFrequency": 2,
  "accountAge": 365,
  "emailDomain": "protonmail.com",
  "addressMismatch": true,
  "twoFactorAuth": false,
  "referralSource": "Google Search",
  "proxyOrVPN": true,
  "orderQuantity": 1,
  "strictness": 50
}'

Response Format

A sample response looks like this:

{
  "transactionId": "821c09c1-fdaa-4199-b3ea-c4b715f8a150",
  "ConfidenceLevel": "Medium",
  "Result": "Failed"
}

Risk Level Definitions

Risk Level	Description
`0`	Critical Risk - Immediate Failure
`1`	High Risk - Manual Verification Required
`2`	Failed
`3`	Monitor Closely - Review Logs
`4`	Low Risk - Auto Approved
`5`	Safe Zone - Pass
`6`	Caution - Review Recommended
`7`	Additional Verification Needed (Fallback)

Additional Information

Error Handling

The service class (FraudBusterService) handles errors using exceptions.
Laravel’s built-in logging system can be used to log API errors for debugging.

Production Notes

Ensure .env is properly configured for production.
Use HTTPS for secure API communication.
Add rate-limiting if required for sensitive endpoints.

FAQ

For more details and troubleshooting tips, visit our FAQ section.

Let me know if you need further enhancements!

Installation

React

Getting Started

React Hooks