Requesting API Access from Suppliers
Follow this process to gather API access and integration documentation from your existing suppliers so Fisar can complete your integration setup securely.
Overview
If you want to connect Fisar to a third-party system such as SIMS, CPOMS or SAM People, you will usually need to gather API or integration information from that supplier first.
In some cases, this information may already be available in the supplier’s documentation, admin settings, or developer portal. In others, you may need to contact the supplier directly.
The goal is to collect the information Fisar needs to review and complete the integration.
Keep the request short and practical. You are simply trying to confirm what integration options are available and what is needed to enable access.
When to use this
Use this process when:
-
you already use the supplier’s system
-
you want to connect that system to Fisar
-
Fisar has asked you to obtain API or integration details
Check existing access
Some suppliers provide API details in their documentation, portal, or account settings.
Contact the supplier
If the information is not available, send a short email using the template below.
Upload securely
Add any keys or documentation to the secure Google Drive document shared by Fisar.
Process
Choose the supplier
Identify the system you want to connect, such as SIMS, CPOMS or SAM People
Check their documentation or settings first
Before emailing the supplier, check whether API or integration details are already available in their help centre, developer docs, admin settings, or account portal.
You may be able to find:
-
API documentation
-
available integration methods
-
setup instructions
-
tenant or endpoint details
-
existing API keys or key generation options
Send the template email if needed
If the information is not already available, use the email template below and replace [System Name], [Name], and [Sender name].
Gather the supplier response
The supplier should confirm what integration options are available and what is needed to enable access, including any keys, permissions, approvals, or documentation.
Upload everything to the secure Google Drive document
Do not email sensitive details back to Fisar unless your onboarding contact has specifically asked you to do so.
Instead, upload the relevant documentation, notes, and any access details to the secure Google Drive document shared with your team. Access is restricted to:
-
the relevant people at your organisation
-
authorised members of the Fisar team
This helps keep API and integration information more secure than sharing it in plain email.
Allow time for setup
Once Fisar has the required information, please allow 24–48 hours per integration for review and setup.
What to look for
Before contacting the supplier, check whether you can already access any of the following:
-
API or developer documentation
-
integration guides
-
admin settings related to API access
-
existing credentials or key generation tools
-
endpoints, tenant IDs, or application details
-
approval or permission requirements
What to ask for
If you need to contact the supplier, ask them to provide:
-
any available API or integration documentation
-
the process for enabling access
-
any API keys, permissions, or approvals required
-
any technical prerequisites, restrictions, or next steps
Email template
Subject: Fisar integration with [System Name]
Hi [Name],
We’re currently working with Fisar to set up an integration with [System Name].
Please could you let us know what’s needed from your side to enable this, and send over any relevant API or integration documentation?
If API access is available, please also let us know the process for getting this set up, including any keys, permissions or approvals required.
Many thanks,
[Sender name]
Last updated today
Built with Documentation.AI