Application Programming Interfaces, known as APIs, are technical interfaces that allow your system to talk directly to our system. Once setup, your system can retrieve information or submit information automatically into ours.


Who should consider using APIs?

Developers of logbooks for Electronic Reporting and high volume users of FishServe's services. For example, those who submit multiple and/or large ACE transfers, or those wanting to use our data in their own systems.


What APIs are available?

You can carry out the following via APIs:

FishServe APIs

  • Client Search: Returns public information about a FishServe client (e.g. Name, Permit Status).
  • ACE Transfer Submission: Performs an ACE transfer
  • ACE Transfer History Search: Returns a list of ACE Transactions for a client.
  • ACE Transfer History Lines Search: Returns all of the stocks included in a transaction

In the future there will also be APIs available for MHRs and LFRRs

Electronic Reporting APIs

  • Event APIs: Submit, retreive or amend Fishing and Non-Fishing Events that occur on trips. Such as a Trawl Event or a Processing Event
  • Master Data APIs: Retrieve relevant data to be used when creating Fishing and Non-Fishing Events. Such as stock code lists or fishing methods.

Are there any costs involved?

While there is no charge for using our APIs, the standard cost for submitting ACE transfers will still apply. Therefore the ACE transferor must be a client setup to pay by invoice.


How do I get started?

Explore the list of available FishServe APIs here

Explore the list of available ERS APIs here.

If you require further help, please contact us.


System Change Log

Below is a log of changes that have been applied to our PROD and UAT systems. Future dated changes are subject to change.

DateEnvironmentTypeDetails
25/11/2021 PROD Website/ER Bug fixes for website. Removed mitigation device master data for FC method
25/11/2021 UAT Website/ER Bug fixes for website. Removed mitigation device master data for FC method
22/09/2021 PROD Website

Bug fixes for website

Webhooks

07/09/2021 PROD Website/ERS

Bug fixes for website

Circular Changes 2021

08/06/2021 PROD Website

Bug fixes for website

Change in "Discrepancies" tab of exported trip

"Total Catch" added to exported CSV of "ACE & Catch Position"

02/06/2021 UAT Website

Bug fixes for website

"Total Catch" added to exported CSV of "ACE & Catch Position"

27/05/2021 UAT Website

Bug fixes for website

Change in "Discrepancies" tab of exported trip

10/05/2021 PROD Website

Bug fixes for website

06/05/2021 UAT Website

Bug fixes for website

29/03/2021 PROD Website

Bug fixes for website

25/03/2021 UAT Website

Bug fixes for website

23/12/2020 UAT Website

New SSL Certificate

15/12/2020 UAT Website

Bug fixes for website

Browsers support functionality

14/12/2020 PROD Website

Bug fixes for website

09/12/2020 PROD Website

Bug fixes for website

03/12/2020 UAT Website

Bug fixes for website

23/11/2020 UAT Website

Bug fixes for website

19/11/2020 UAT Website

Bug fixes for website

18/11/2020 PROD Website

Additional ER exports functionality

Minor bug fixes

Performance enhancements

13/11/2020 UAT Website

Additional ER exports functionality

Minor bug fixes

Performance enhancements

14/10/2020 PROD Website

Bug fixes for website

01/10/2020 PROD Website

Bug fixes for website

10/09/2020 PROD Website

Enhancements to SRE sub-stock management

Bug fixes for website

Bug fixes for website

09/09/2020 UAT Website

Bug fixes for website

31/08/2020 UAT Website

Enhancements to SRE sub-stock management

"Discrepancies" tab added in exported trip

Bug fixes for website

08/07/2020 PROD Website

ER Mapping update

Create ACE functionality

Bug Fixes

07/07/2020 UAT Website

Bug fixes for website

30/06/2020 UAT Website

ER Mapping update

Create ACE functionality

Bug Fixes

22/05/2020 PROD Website

Additional Marine Farm functionality.

Removed ER Readiness functionality.

Bug Fixes

22/05/2020 UAT Website

Additional Marine Farm functionality.

Removed ER Readiness functionality.

Bug Fixes

01/05/2020 PROD Website

Bug fixes for website.

01/05/2020 UAT Website

Bug fixes for website.

08/04/2020 PROD Website

Bug fixes for website.

08/04/2020 UAT Website

Bug fixes for website.

27/02/2020 PROD Website

Bug fixes for website.

26/02/2020 UAT Website

Bug fixes for website.

25/02/2020 UAT Website

Bug fixes for website.

25/02/2020 PROD Website

"Marine Farms" added to Licenses tab.

"Trip Summary" filter criteria changed.

Website performance improvements.

Bug fixes for website.

13/02/2020 UAT Website

Bug fixes for website.

07/02/2020 UAT Website

"Marine Farms" added to Licenses tab.

"Trip Summary" filter criteria changed.

Website performance improvements.

Bug fixes for website.

17/12/2019 PROD Website

Sub Stocks reporting.

Vessel under 6m GPR.

16/12/2019 UAT Website

Bug fixes for website.

25/11/2019 PROD Website

"Sub Stock ACE & Catch" and Trip Catches added to SRE tab.

Landing code can be changed in an ER report.

"Fishing methods" filter introduced in Mapping.

Bug fixes for website.

20/11/2019 UAT Website

Bug fixes for website.

10/10/2019 PROD Website

Bug fixes for website.

26/09/2019 PROD Website

Added SRE tab with Infomation Hub and Sub Stock Transfers.

Vessel manager can create ER reporter through vessel registration.

Bug fixes for website.

25/09/2019 UAT Website

Added SRE tab with Infomation Hub and Sub Stock Transfers.

Vessel manager can create ER reporter through vessel registration.

Bug fixes for website.

5/9/2019 PROD Website/ER

Added toggle for latitude and longitude formats in ER events

Bug fixes for website.

3/9/2019 UAT Website/ER

Added toggle for latitude and longitude formats in ER events

Bug fixes for website.

20/8/2019 UAT Website/ER

Additional secondary validation rules.

Secondary validation rules suppression screen.

Dredge and Tuna-Lining ER event exports.

Bug fixes for website.

19/8/2019 PROD Website/ER

Additional secondary validation rules.

Secondary validation rules suppression screen.

Dredge and Tuna-Lining ER event exports.

Bug fixes for website.

2/8/2019 UAT Website/ER

Additional secondary validation rules and validation rule API for ER, and bug fixes for website

4/7/2019 PROD Website/ER

Minor bug fixes for Mobile GPR's and ER amendments of different time zones

25/6/2019 PROD Website/ER

Minor bug fixes for ER readiness widget

20/6/2019 PROD Website/ER

Minor bug fixes for website and ER secondary validation

26/5/2019 PROD Website/ER

Additional ER Secondary validation rules and minor bug fixes for website

2/5/2019 PROD Website

Minor bug fixes for website

29/4/2019 UAT Website/ER Minor bug fixes for website
17/4/2019 PROD Website/ER

Introduced secondary validation for ER

Minor bug fixes for website

16/4/2019 PROD ER

Disabled old authorisation process for logbooks

08/4/2019 UAT Website/ER

Introduced secondary validation for ER

Minor bug fixes for website

24/3/2019 UAT ER Disabled old authorisation process for logbooks
19/2/2019 PROD Infrastructure Disabled TLS1.0 and TLS 1.1 on all servers