Development
The latest updates to the API can be found on the Releases page.
Examples of requests made to the services please see the Examples page.
Endpoints
The endpoints are
Testing:
- https://api.themovingportal.dev
- https://api.imyhome.dev
Production:
- https://api.themovingportal.co.uk
- https://api.imyhome.co.uk
You can find Swagger definitions/UI at the following locations:
- https://api.themovingportal.dev/tmpservices/swagger/index.html
- https://api.themovingportal.co.uk/tmpservices/swagger/index.html
Test system
When we setup your firm on the testing system it will NOT have your firms real name. This is to make it clear to future customers if you accidentally make this available in production. THIS HAS BEEN DONE BEFORE.
Emails
The testing system is setup to operate normally. IT WILL SEND EMAILS. e.g. if you set the customer email address then any emails will be sent to that address. Ensure that all your development takes this into account.
We do however operate an allowed list on the testing system for SMS messages.
How to create customers and not send emails
If you create a customer with an email address ending in .nosend then no email will be sent.
Plus addressing
One approach that we have taken to is to use plus addressing. This allows emails to be received into the same mailbox.
e.g. if your normal email address is ken.carson@myfirm.com, then emails sent to ken.carson+customer1@myfirm.com should be received into your mailbox
Not always supported
Plus address is not supported by all email systems and some email systems can disable this.
SMS messages
We operate an allowed list on the testing system for SMS messages.
Current issues
General
If you use the Swagger definitions these will contain references to response codes that aren't in use or the API will return response codes not defined. They will be cleaned up over time and with continual review.
Quote and Instruction services
Internally Quotes and Instructions are separate entities and stored as such - they hold separate types data and are for different purposes. However, some of the data is similar.
Instructions search service
- It is not possible for an Introducer to search by Introducer references or return the references.
- It is not possible for an Supplier to search by Supplier references or return the references.
- It is not possible to search by case index. This is not currently an issue as each instruction has only one case.
Testing service DEPRECATED
This service has been removed. Interactive functionality to assist developers with integration testing has been put in place instead.