README

A PHP library to check seafarer details from INDOS numbers as issued by the Directorate General of Shipping, Mumbai, India. Queries the DGS eSamudra server and returns validated INDOS records.

Requirements

• PHP >= 8.1
• Composer

Dependencies

Installation

composer require renderbit-technologies/indos-checker-api

Usage

Check if an INDOS number is valid

use RenderbitTechnologies\IndosCheckerApi\IndosChecker;

$checker = new IndosChecker();
$checker->checkValid('05LL0262', '14/08/1963');
// true

Retrieve seafarer details

$data = $checker->getData('05LL0262', '14/08/1963');
// [
//     "Name"                => "YADAV SANJEEV",
//     "Date of Birth"       => "14-AUG-1963",
//     "INDoS No."           => "05LL0262",
//     "Passport No."        => "M2069200",
//     "Passport Issue Date" => "15-SEP-2014",
//     "Passport Valid To"   => "14-SEP-2024",
//     "CDC No."             => "MUM 133201",
//     "CDC Issue Date"      => "22-MAY-2015",
//     "CDC Valid To"        => "21-MAY-2025",
//     "CDC Issue Place"     => "Mumbai",
// ]

The returned array contains up to 10 fields: Name, Date of Birth, INDoS No., Passport No., Passport Issue Date, Passport Valid To, CDC No., CDC Issue Date, CDC Valid To, and CDC Issue Place. An empty array is returned when no record is found.

Exception handling

use RenderbitTechnologies\IndosCheckerApi\IndosCheckerException;

try {
    $data = $checker->getData($no, $dob);
} catch (IndosCheckerException $e) {
    // Network or server error — inspect $e->getPrevious() for the Guzzle cause
} catch (\InvalidArgumentException $e) {
    // Bad input: empty INDOS number or wrong date format (must be DD/MM/YYYY)
}

• IndosCheckerException wraps all Guzzle/HTTP errors (timeouts, connection failures, server errors).
• \InvalidArgumentException is thrown for invalid input: empty or whitespace-only INDOS numbers, or DOB not in DD/MM/YYYY format.

Custom HTTP client

Pass a configured GuzzleHttp\Client to override timeouts, proxies, etc.:

$client  = new \GuzzleHttp\Client(['timeout' => 5.0]);
$checker = new IndosChecker($client);

Custom endpoint

Override the default DGS eSamudra endpoint (useful for testing):

$checker = new IndosChecker(null, 'http://staging.example.com/indos');

Project Structure

Indos-Checker-API/
├── src/
│   ├── IndosChecker.php          # Core class: validation, HTTP request, HTML parsing
│   └── IndosCheckerException.php # Custom exception for API/network errors
├── tests/
│   └── IndosCheckerTest.php      # PHPUnit tests (input validation, parsing, exceptions)
├── .github/
│   ├── workflows/tests.yml       # CI: tests on PHP 8.1–8.4
│   └── dependabot.yml            # Automated dependency updates
├── composer.json
├── phpunit.xml
└── LICENSE                       # MIT

Testing

composer install
vendor/bin/phpunit

CI

GitHub Actions runs the PHPUnit suite on every push and pull request to master, across PHP 8.1, 8.2, 8.3, and 8.4.

License

MIT © Renderbit Technologies