Overview

Packages

  • LegiScan
    • API
    • Cache
    • Common
    • Exceptions
    • Utility
  • PHP

Classes

  • LegiScan
  • LegiScan_CommandLine
  • LegiScan_Endpoint
  • LegiScan_Import
  • LegiScan_WebTest
  • LegiScan_Worker
  • Overview
  • Package
  • Class

Class LegiScan_Endpoint

A push endpoint server for LegiScan Push API subscriptions

The legiscan-push.php script serves as the endpoint listener for LegiScan Push API services. This will receive payloads from the LegiScan Push server and process them into the provided database. The LegiScan API Client should be installed in a location that is accessible by your web server and externally by LegiScan servers.

For additional authentication you may also set api_auth_key which can be found / updated from the LegiScan API control panel at legiscan.com. This will validate against the HTTP Authorization header sent with incoming payloads and reject those with invalid tokens.

If your API key is set to receive cooked application/x-www-form-urlencoded payloads, be sure to change the push_form_var setting to the form variable name specified in the API control panel.

NOTE: To utilize this script you will need a Push API subscription.

Package: LegiScan\Utility
Copyright: 2010-2020 LegiScan LLC
License: https://opensource.org/licenses/BSD-2-Clause
Author: LegiScan API Team api@legiscan.com
See: LegiScan_Process
See: LegiScan_Push
Link: https://api.legiscan.com/dl/
Located at legiscan-push.php
Methods summary
public
# process( )

Endpoint listener for LegiScan API Push subscriptions to process an incoming push payload to the database.

Endpoint listener for LegiScan API Push subscriptions to process an incoming push payload to the database.

LegiScan API Client API documentation generated by ApiGen