Technical Document for RAS Integration

Technical document for RAS Integration

RAS Server Integration 1. IP White listing and Port Opening: RAS application is hosted on NIC cloud. RAS Server IP which is to be white listed at integrating department end is 164.100.94.217 for ports 443 & 80 (for out bound traffic from your server) if POST based HTTP is restricted from your firewall. In-bound and outbound traffic from/to departmental server to/from 164.100.94.217 should be allowed on port 443 and 80. Usually on state servers inbound traffic on port 443 and 80 is allowed but outbound traffic is blocked. Exception: If the state application is also hosted on NIC cloud with same segment which is 164.100.94, it is not required to open any port.

2. RAS Live URL and Test Account: The RAS landing page is https://ras.gov.in. You may click on the “Departmental Login” section to go to the following URL – 1. https://ras.gov.in /login Then use the following credentials to log into the test account for reference -

1. Select User - Department 2. Username- [email protected] 3. Password – Admin#123

3. Account Creation: NeGD would create a similar account for the department/state with feedback SMS questions and feedback web questions on RAS test server. The feedback web question list has to be provided by the department/state. Once the account is created, the account credentials would be shared with department/state over e-Mail. Please let us know the department name and the list of citizen centric services which would be integrated with RAS so that corresponding Department ID and Service ID can be created and shared with department/state.

4. API Calling for initiating feedback: The following API needs to be called by the state/department once we create an account for the department/state – https://ras.gov.in/webservices/addfeedbackuser

It is a simple HTTP Post request.

Parameter Name and Data to be passed in the above mentioned API “addfeedbackuser” is as below –

# Parameter Name Parameter Data Type Data description Description

1 m Citizen’s Mobile Integer Either email id or mobile no. no. is mandatory

2 e Citizen’s e-Mail ID String Either email id or mobile no. is mandatory

3 age Citizen’s age Integer Optional

4 gender Citizen’s gender String (Male- >‘M’, Optional Female - > ’F’)

5 lname Citizen’s Last NameString Optional

6 fname Citizen’s First String Optional Name

7 registration_no Application No. for String Optional repeat services such as electricity bill payment.

8 addl_info For any additional String Optional info

9 d Department ID String Mandatory. Will be provided by us.

10 s Service ID String Mandatory. Will be provided by us.

11 st State ID String Mandatory. Will be provided by us.

5. API Response Handling: The API returns success or failure message based on the records which are tried to be inserted from department/state end. Maintain a table with a flag to record the status of data sent to RAS server. a. If the error message is “404-page not found”, that means RAS server may be down temporarily or department is not be able to connect due to connectivity problem. So in this case, records has to be kept locally with pending status and should be re- attempted every 1 Hrs interval till all the pending records are inserted. b. If the error code is with value “1” and error description is “system under maintenance”, then these records has to be kept locally with pending status and should be re-attempted every 1 Hrs interval till all the pending records are inserted. c. For other type of error messages, appropriate action may be taken depending on the message. Say, for an example if the Mobile Number format is invalid, it may be corrected as per the desired format and re-attempted later. d. In case the same record is tried to be inserted multiple times, error message “Duplicate Data” is returned with error code as “1”. e. In case invalid Department/State/Service ID is passed in API parameter, error message “Invalid Data” is returned with error code as “1”. f. The following is the detailed description of error codes -

is_error is_code Error Description 0 0 Data sent successfully 1 11 Invalid email format. 1 12 Invalid mobile no.

1 13 Invalid state id

1 14 Invalid Department id.

1 15 Invalid service id for this department.

1 16 Invalid Age. Should be between 0 to 100.

1 17 Invalid Gender.

1 18 Additional info should not exceed 100 characters.

1 19 Duplicate Data.

1 20 Invalid Parameter. 1 21 Under Maintenance. 1 22 Service Blocked.

RAS team would provide full technical support during integration. State, Department and Service IDs would be shared by RAS technical team to the department/state during the integration process once the services to be integrated with RAS are shared with the RAS team. Development Server Setup

(In case state/department decides to host RAS instance of their own) 1. Department would download the code from https://ras.gov.in/download . The password to download and open the zip file will be shared offline.

2. Technical Specifications: a. Framework: Cake PHP Framework version 2.9 b. Programming language: PHP version 5.4 c. Database Server: MySql (version 5.5) d. Operating System : Linux 7.1 RHEL e. Web Server: Apache

3. Application file size – 295 MB, Database Size (with only Configuration data) – 4 MB

4. The following steps has to be followed for integration - a. Create department and associated service IDs b. Configure SMS gateway related short code for feedback SMS c. Configure and integrate e-Mail server d. Configure application for feedback through Configure Feedback Module e. Configure Dash Board f. Integrate RAS instance with the departmental/state application by calling API as mentioned above in first section para 4.

5. If the application is planned to be hosted on a different VM, the state/department has to apply for a domain name. The domain name can be ras..gov.in.

Application configuration steps: 1. Usually server machines come with the script packages installed. Install LAMP stack on the web server machine if already not present on server machine.

2. The project is usually kept at /var/www/html.

3. Change the variable “siteurl” in “core.php” present under “config” directory with the host URL. It is assumed here that domain name is already taken.

4. Change the variable “hostname”, “username”, “password”, “database name” in “database.php” present under “config” directory.

5. Import the database script to be provided by RAS team to the MySql database.

When the application is running please let us know. We will help with the further steps. *First the application has to be tested on staging server. Once successful, the same can be moved to the production with live data.