Overview
  • Namespace
  • Class

Namespaces

  • APWG
    • API
      • Alerts
      • Groups
      • Index
      • MalIP
      • Phish
      • ReportPhishing

Classes

  • APWG\API\AbstractClient
  • APWG\API\Alerts\AlertsClient
  • APWG\API\Groups\GroupsClient
  • APWG\API\Index\IndexClient
  • APWG\API\MalIP\MalIPClient
  • APWG\API\Phish\PhishClient
  • APWG\API\ReportPhishing\ReportPhishingClient

Interfaces

  • APWG\API\ClientInterface
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 
<?php

namespace APWG\API\Index;

use APWG\API\AbstractClient;
use Psr\Http\Message\ResponseInterface;

/**
 * Interact with the Index API
 *
 * Class IndexClient
 * @package APWG\API\Index
 * @author Andrew Breksa <andrew@apwg.org>
 * @copyright Copyright (c) 2017 The Anti-Phishing Working Group
 */
class IndexClient extends AbstractClient {

    /**
     * Returns the Swagger 2.0 YAML definition
     *
     * @return ResponseInterface
     */
    public function getSpec() {
        return $this->_call('get', '/spec', []);
    }

    /**
     * Returns the '/' index content of the API, a list of available modules, groups, and utilities
     *
     * @return ResponseInterface
     */
    public function getIndex() {
        return $this->_call('get', '/', []);
    }
}
API documentation generated by ApiGen