You can use our test environment to develop and test your application.

To setup access and begin using our APIs, you will need to contact us for a username and password.

Test url: https://register.demo.kupe.fishserve.co.nz/

When you have completed testing, you will need to use an existing production username and password or set up new authorisations to access the live services.

Production url: https://fishserve.co.nz/

Authentication

All requests to the API must be authenticated, the user token should be specified in the authorisation header.

The username and password must relate to a user / person / authorisations set up to use the FishServe website.  We do not authenticate the application calling the API or the FishServe client being called for. 

The API request requires;

  • Username
  • Password

The response provides;

  • An authenticated user token for use in the request header of other APIs

Back to top

Authentication Technical Information

All requests to the API must be authenticated, the user token should be specified in the authorization header.

Request

Request Url
POST https://api.demo.kupe.fishserve.co.nz/authenticate
Request Header
Content-Type: application/json
Request Body Parameters
ParameterRequiredData typeDescription
Username Mandatory String The user name
Password Mandatory String The password
Request Body
{
  "username": "{Username}",
  "password": "{Password}"
}

Example:

{
  "username": "Test",
  "password": "Test123"
}

Response

Response Parameters
ParameterData typeDescription
UserToken String The user access token
Response Body
{
  "userToken": "{UserToken}"
}

Example:

{
  "userToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjY2di0xZUp0OEZlazhxNmh"
}

Back to top