.. RAE Documentation documentation master file, created by sphinx-quickstart on Mon May 8 14:55:04 2023. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to the Right Angle Engineering API! =========================================== It is our goal with this API to streamline the permitting process for solar panel installation. This API documentation outlines all of the necessary elements to submit a solar project to Right Angle Engineering for Roof Structural Evaluation, CAD Design, and Electrical/Structural Stamps. About Us -------- At Right Angle Engineering, we are dedicated to providing top-notch CAD Design and Engineering services to Solar Install companies. With our specialized API, we make it easier than ever for solar installers to submit their projects that require CAD Design and Engineering support. Who Can Benefit from Our API? ------------------------------ Our API is designed specifically for Solar Install companies looking to streamline their project submission process and enhance collaboration with CAD Design and Engineering experts. Whether you are a small installer or a large enterprise, our API offers seamless integration into your existing systems. Key Features of the API ------------------------ - **Project Submission**: Submit project details directly to our team, ensuring accurate and timely processing. - **Engineering Requirements**: Specify engineering needs to receive tailored solutions for your projects. - **CAD Design Services**: Leverage our expertise in CAD Design to create precise and efficient project plans. - **Real-time Updates**: Stay informed about the status of your projects with real-time updates and notifications. - **Secure Data Handling**: We prioritize data security and handle all information with the utmost confidentiality. - **Effortless Integration**: Our API is designed to integrate seamlessly into your workflow, reducing development time. How to Get Started -------------------- Getting started with our API is quick and straightforward. Follow these simple steps: 1. **Sign Up**: Create an account on our platform to access the API credentials. 2. **Authenticate**: Obtain your API key to start making requests. 3. **Explore Endpoints**: Review our comprehensive API documentation to understand the available endpoints and their functionalities. We have also included examples on Postman at https://postman.com/right-angle-eng/workspace/right-angle-engineering-api 4. **Test in Sandbox**: Experiment with the API in the sandbox environment to ensure it meets your requirements. 5. **Go Live**: Once you're ready, switch to the production environment and start submitting your projects for CAD Design and Engineering services. Information submitted to Right Angle Engineering can also be accessed by logging into the Right Angle Engineering Portal. You can log in at https://rightangleeng.com/login using credentials provided to you by Right Angle Engineering. If you have not yet created an account with Right Angle Engineering, you can do so by reaching out to us at https://rightangleeng.com/contact-us. Contact Us ----------- If you have any questions, feedback, or need assistance, our dedicated support team is here to help. Reach out to us via email at solar@rightangleeng.com or visit our website at www.rightangleeng.com for more information. .. toctree:: :maxdepth: 2 :caption: Contents: api/accessing_api api/request api/submit_job api/endpoints api/webhooks