Compliance API is now available

Hi Developer Community,

 

We now have the HCSS 2019 compliance/testing APIs up and ready for your test submissions. Please start your submissions to see if there are any validation issues with the API calls your software is making. 

With getting this environment up and available, we have had to make some changes to the swagger docs and do some minor adjustments to typos and errors, but we have now our finalised these details in the swagger doc.  

 

The main changes that you will need to be aware of is the change of URLs for each API endpoint. The previously displayed URLs were incorrect and have been adjusted to the correct information for our compliance/testing environment.  

Correct URLs for our compliance HCSS 2019 APIs

Service Consultations - https://api-compliance.acc.co.nz/v1/provider/home-community-support-services/service/consultations

Supplier Review - https://api-compliance.acc.co.nz/v1/provider/home-community-support-services/supplier

Service Review - https://api-compliance.acc.co.nz/v1/provider/home-community-support-services/service/review

Service Completion - https://api-compliance.acc.co.nz/v1/provider/home-community-support-services/service/completion

Service Commencement - https://api-compliance.acc.co.nz/v1/provider/home-community-support-services/service/start

 

Correct URLs for our production HCSS 2019 APIs

The relevant production API URLs will be the same as above but with the "-compliance" part removed. All apikeys will not be able to access this live environment until the production APIs are live (currently planned for 22nd of July) AND the organisation has passed the test scenarios. These scenarios are due to be released tomorrow (04/07/2019). 

 

Security for these APIs

No digital certificates are required when making an API call to these particular APIs, but a valid apikey needs to be included in the transaction. The incorrect URLs were set to http but the correct URLs use https, so please remember to use this with your configuration within your systems. 

 

If there are any issues or if you have any questions, please let us know via the forums or through the digitaloperations@acc.co.nz email and we will be happy to help. 

Kaaran@ACC

 

 

Hi,

When will the compliance scenarios be made available?


Hi,
We have been getting errors from the test infrastructure since yesterday afternoon.

Sometimes the calls go through but mostly we get:

Gateway timeout errors

and

500 internal errors e.g:
{
"fault": {
"faultstring": "Rate limit quota violation. Quota limit exceeded. Identifier : _default",
"detail": {
"errorcode": "policies.ratelimit.QuotaViolation"
}
}
}

Can you please confirm when we can resume testing?

thanks


Hi,

We're getting the same error, too.

Thanks.


@Lyndsayl - we have completed the test scenarios which can be found here - https://developer.acc.co.nz/test-scenarios-hcss-2019

Kind Regards

Kaaran@ACC


@Randy and @Paul - With our APIs we have throttling and spike arrest policies in place when the volume of submissions per minute exceed the limits on our network. From the error message above, i can confirm that you have unexpectedly run into this. 

I have been doing some submissions today and have not been running into any issues, so these APIs should be available to you now. 

Our spike arrests apply per apikey and/or for all submission into our APIs and with all the current vendors doing submissions, you may have inadvertently run into one of these periods. The throttling and submission controls will stop after a sufficient cooldown period, typically just a few minutes. 

If you want more information, please let us know. 

Kaaran@ACC


Hi @Kaaran,

I am getting the same quota error as Paul and Randy. However, I have only just created my ACC app, and it is giving me a quota error from the first send from Postman, using the Guptill test scenario. I obviously haven't gone over my quota, unless the quota is zero. This is going to be very frustrating in developing and testing if we can't get this resolved.

Thanks for your help
Jonathan


Hi Dev community, 

Thank you for the heads up about the ongoing issue. I have reset the quota limits and adjusted some settings and you should now have unfettered access into the HCSS apis. 

Please try your submissions and if any further issues occur, please let us know. 

Kind Regards

Kaaran@ACC