baygroup/ramci

Library to pull reports from RAMCI

0.5.1 2018-03-30 07:17 UTC

Requires

• guzzlehttp/guzzle: ^6.3

MIT

• Michael Grunewalder

README

This lLibrary allows to query the RMACI B2B API for registered users.

You need the access details that were provided to you to make any calls to the API. For exact parameters in the data array/XML, refer to your offline documentation.

If you do not know what all this is about, then you probably do not need or want this library.

Configuration

.env file

Configuration via the .env file currently allows the following variables to be set:

• RAMCI_BASE_URL : the base URL for the API endpoint WITHOUT the command (report/xml/pdf)
• RAMCI_USERNAME : the username to access the API
• RAMCI_PASSWORD : the password to ccess the API

###Example: if the urls you have to generate the reports are

• http://api.endpoint/url/report
• http://api.endpoint/url/xml
• http://api.endpoint/url/pdf

and your username is demouser with password demoPassword then:

• RAMCI_BASE_URL='http://api.endpoint/url/'
• RAMCI_USERNAME=demouser
• RAMCI_PASSWORD=demoPassword

Available functions

RAMCI::generateXMLFromArray($data)

This function takes an array of options for the RAMCI API and generates the XML code that can be submitted via the API Call. Example:

      [
       'ProductType'   =>  'CHECK_DATE_COMPANY',
       'EntityName'    =>  'My Company Name',
       'EntityId'      =>  '123456789'
      ]

will generate

      <?xml version="1.0"?>
      <xml>
            <request> 
                  <ProductType>CHECK_DATE_COMPANY</ProductType>
                  <EntityName>My Company Name</EntityName>
                  <EntityId>12356789</EntityId>
            </request>
      </xml>

RAMCI::getReport($requestXML, $command='report', $sendXML=true)

This function tries to retrieve the report data from RAMCI and returns the XML response; In case of a connectino error, it returns FALSE,

If the request was succesful but the query resulted in data related errors, the returned array will have the fields:

code : contains the error code received from RAMCI error : contains the error message received from RAMCI

A succesful request returns the XML of the requested report

OPTIONAL PARAMETER $command:

By default the request calls the "report" endpoint you can change to the 'xml' endpoint by sending the optional parameter $command with a value of 'xml' - 'pdf' is not supported by this function

OPTIONAL PARAMETER $sendXML:

If this parameter is set to false, the funcitno will return the data as an associative array. The XML tag names are the keys of the array, the XML values obviously the data of the array