How It Works
Here's a guided integration process to walk you through integrating with the Embed Ecosystem.
Explore the API Finder
Use our API selection tool and review the detailed overview for each API to find the most suitable route for your integration needs. Check if the functionality matches your solution requirements.
Submit Enquiry
Fill out the enquiry submission form to share requirement details and request access for more details on the API/s of interest. Use the "Initial Questions" field to share any questions you may have based on your documentation review. Please check out our "Integration Service Agreement" before submission.
Enquiry Review
Upon initial approval, our Integrations Team will provide login access to the endpoints and further technical details of all APIs. If necessary, we will request a meeting to talk give more information, or engage you further to discuss your initial questions.
Please note that Embed reserves the right to decline integration requests at its discretion.
Planning and Design
Now that you have access to the full documentation, you can design your integration. Embed will also be available for an initial 60 minute consultation to answer your questions and validate your approach. It is at this point that you can decide to proceed to the development stage. Embed will share an invoice with the integration fee of $1,500.
Development and Testing
To support the development of your integration, Embed can provide an additional 60 minute consultation to assist with any further technical questions or troubleshoot any challenges.
Upon request, Embed will also provide access to one of our test environments to allow you to simulate your integration calls and receive the exact responses. Please note that due to demand for test environments, we require the access to be scheduled in advance to allow setup. The environment will be available for your testing for five business days. Additional testing days and consultation may be purchased based on availability.
Certification
To complete your integration with Embed and one of our API's, you will be required to provide documentation on your work that includes available functionality, setup / configuration details and a support contact. You will be given a selection of test calls appropriate to your integration and an environment will be made available for you to submit your tests. You will also need to provide JSON detail of the calls made and the response to each call you received and Embed will validate these within our system. Please note that this step is not required for Central Reports (CR2) integrations.
Embed Notice of Certification
Embed will provide an email that your certification is successful and we will complete steps on our internal systems to ensure that operators of Embed locations can access the integration when requested. It should be noted that there are operator fees to provide access to API’s or cloud modules.
Go Live
With certification confirmed and your integration enabled on our systems, you're ready to go live.
Start your integration
Explore the available APIs that match your needs and requirements. Use our API Finder to get started with Step 1 of the integration process.