Introduction
We understand the importance of seamless integration between your Student Records System (SRS) and Student CRM. One of the key values of our CRM solution is its ability to communicate effectively with your SRS, enabling streamlined workflows and data synchronisation. To support this integration, we provide controlled access for your university’s developer to our API and a sandbox environment for testing purposes. This article outlines the process, resources available, and the critical controls in place to ensure a secure and successful integration.
Who Is This Article For?
This article is designed for university clients who have purchased Student CRM and wish to integrate it with their existing Student Records System (SRS). Specifically, it is aimed at:
University staff responsible for overseeing technical integrations.
Developers employed or contracted by the university to set up the SRS-CRM connection.
Independent contractors or external providers working on the integration project on behalf of the university.
The Importance of Scope and Controls
While our existing article provides a general guide to integration, this piece focuses on ensuring the project is tightly scoped and well-controlled to:
Protect the integrity and security of your CRM data.
Avoid unnecessary exploration beyond the Applications app.
Provide developers with clear boundaries and tools for effective testing.
Minimise risks by limiting access to what is necessary for the project.
Project Scope
The developer’s access is strictly limited to the following:
Testing API Connections: Focused solely on the Applications app within Student CRM to integrate with your SRS.
Sandbox Environment: A secure and isolated testing environment with test data to validate the integration.
Defined Integration Goals: The project scope is limited to connecting your SRS to Student CRM, without extending into other CRM functionalities or apps.
These limitations ensure that your CRM’s operational and data integrity remains uncompromised.
Resources Available
We provide the following resources to support your developer:
Comprehensive Technical Documentation: Detailed guides on API endpoints, authentication, and data structures.
Sandbox Environment: A simulated space to test API calls and validate SRS-CRM connections using test data.
Support Access: Our technical team is available to answer questions related to API usage during the integration period.
Best Practices Guide: Tips and guidelines to ensure developers operate within the defined project scope.
Access Controls
Limited CRM Access: Developers are restricted to the sandbox and the Applications app. They cannot access other parts of the CRM or the live system.
Temporary Access Period: Access is granted only for the duration of the integration project and revoked immediately after the API setup is completed.
Secure Testing Environment: The sandbox is isolated, containing only test data to prevent any unintended impact on live CRM operations.
Monitoring and Auditing: All sandbox activities are logged to ensure compliance with the defined scope.
Liability and Responsibilities
The developer is employed by, contracted to, or acting on behalf of the university and is therefore accountable to the university.
Our sandbox and resources are provided to support the integration, but the university’s developer bears responsibility for ensuring their work aligns with the university’s requirements and policies.
Steps to Gain Access
Request Access: The university’s authorised representative should submit a request to our support team.
Verification: We will verify the request and set up sandbox access for the developer.
Access Provision: Credentials and documentation will be shared with the developer.
Integration Testing: The developer can begin testing API connections in the sandbox environment.
Access Revocation: Once the integration is complete, access will be revoked.
Conclusion
By providing tightly scoped and controlled access to your university’s developer, we ensure a secure and efficient integration process. If you have further questions or need assistance, please reach out to our support team. We are here to support the success of your SRS-CRM connection.
For technical queries, visit our Help Centre Technical Documentation.