Services

These web services can be used by Introducer users and Supplier users as indicated in these documents these coloured badges will appear to try and make it clear which services or methods apply to each type of user.

Examples of requests made to the services please see the Examples page.

The functionality in the API is split up as described below:

For all users

• Authentication - used to get a token for Bearer authentication. Alternatively Basic authentication can be used which does not require using this service.
• Instruction - to retrieve an instruction.
• Instructions search - to find instructions.
• Instruction notification - to retrieve notifications about updates to instructions.
• Notes - to add notes.
• Data - to retrieve data.

For introducers Introducer

• Referral - to create a direct referral and lead.
• Quote - to create a quote and refer it.
• Quotes search - to search for quotes.

There is also an alternative approach to keeping up to date - this is email integration or email automation. Whilst not a recommended approach information can be found at Email integration.

For suppliers Supplier

• Supplier operations - to perform operations on an Instruction