« Back to Contents

Service Provider Setup

After you have contacted Rezare and been issued your Service Provider access key, you will need to go through several steps to set it up. Note: Use the Service Provider access key which was provided by Rezare for all these requests.

Adding Service Provider Credentials

Most movement services require a Service Provider to register with them and receive credentials which are passed to the movement service with every transaction. The first step to complete the Service Provider setup is to add the credentials which you receive from the movement service into EasiTrace so that they can be passed with the transactions.

GET /api/services

If you haven’t already, retrieve a list of all the services available in EasiTrace. This will provide you with information about the movement services which you will need to add the credentials. This list of services is relatively static, so you will be able to download it once and cache it for reuse whenever needed.

Example Request

curl -X GET "https://test-api.easitrace.com/api/services" -H "accept: application/json" -H "X-API-Key: 35383735463137313430363242069241324435444234444245323825334544424112313642444444453130463638344637364438374432394531413930397865"

Example Response

{
  "count": 1,
  "items": [
    {
      "id": "dc7a9226-0568-423c-ada8-76670d9fdd16",
      "tag": "ARAMS-ABATTOIR",
      "name": "ARAMS Abattoir",
      "description": "Animal Reporting and Movement Service",
      "countries": [
        "ENG"
      ],
      "species": [
        "S"
      ],
      "capabilities": [
        "MOV-ON",
        "UPDATEMOV-ON",
        "MOV-CANCEL",
        "MOV-IN"
      ]
    }
  ]
}

POST /api/service-providers/credentials

Use this endpoint to add your credentials against the movement service. These credentials will then be added to each subsequent transaction going to that movement service. The value of the ‘service’ property in the request body is the movement service tag (ARAMS-ABATTOIR in the above example). Note: You are only able to add a single set of credentials for a given movement service. If you try, you will get a 400 (Bad Request) response.
Note: For SCOT-MOVES when credentials are added only the password is provided and not the username.

Model

{
  "username": "string",
  "password": "string",
  "service": "string",
  "programName": "string",
  "programVersion": "string",
  "schemaVersion": "string"
}

Model Notes

• Service is required and is the movement service tag (eg. ARAMS-ABATTOIR in the above example). These are case-sensitive.
• Password is required. If the movement service only provides you one key for their credentials, place it in the password field.

Example Request

curl -X POST "https://test-api.easitrace.com/api/service-providers/credentials" -H "accept: application/json" -H "X-API-Key: 5383735463137313430363242069241324435444234444245323825334544424112313642444444453130463638344637364438374432394531413930397865" -H "Content-Type: application/json" -d "{ \"username\": \"username\", \"password\": \"password\", \"service\": \"ARAMS-ABATTOIR\", \"programName\": \"EasiTrace\", \"programVersion\": \"1.0\", \"schemaVersion\": \"1.3\"}"

Example Response

{
  "credentialsId": "90e16c20-fb89-4cc7-9caf-8a8350286b95"
}