Skip to main content Link Menu Expand (external link) Copy Copied
Ons API

Ons API Dashboard - managing and using certificates

Connections between Ons environments and external systems are secured using certificates. This article explains the process of creating, linking, and approving them.

Certificate Requirements
For information on requirements, details, and examples of certificates, see this article.

Development, staging, productie

We differentiate between the request and approval process between development on the one hand, and staging and production on the other. In development, a connection is made to a Nedap environment; in staging or production, a connection is made to an environment of a healthcare organisation.

Development

This explanation is about connecting to the Nedap development environment.

  • Generate CSR file
    • Generate a CSR file according to the requirements. Use customer code TE1002 for the development environment.
  • Linking
    • Go to the (version of the) connector, then to the certificates tab.
    • Enter customer code TE1002 and click Add new environment.
    • A new line has been created for this environment. Click the upload button in the CSR column and upload the CSR file generated in the previous step.
  • Approval / signing
    • If the certificate meets the requirements, it will be automatically signed.
    • A new button Download PEM file will appear to download the certificate.

    You can now use this certificate to connect with the development environment TE1002 of Nedap.

Staging & Production

This explanation is about connecting to staging and production environments.

  • Generate CSR file

    • Generate a CSR file according to the requirements. Use the customer code that applies to that environment.

      Customer Codes

      • Staging environments start with ‘TE’ followed by 4 digits (except TE1002, which is for development). Example: TE1234.
      • Production environments start with ‘CF’, ‘DF’ or ‘MF’ followed by 4 digits. Example: CF1234, DF6789.
      • Staging environments have a different unique number than production environments; a healthcare organization with staging customer code TE1234 does not have the production customer code CF1234.
      • The healthcare organization can view and provide the customer code to the supplier. See also the Support Portal.
  • Linking
    • Go to the (version of the) connector, then to the certificates tab.
    • Enter the customer code XX#### and click Add new environment.
    • A new line has been created for this environment. Click the upload button in the CSR column and upload the CSR file generated in the previous step.
  • Approval / signing
    • Create a ticket in the support portal and request approval/signature of the certificate. Provide details about the environment in question.
      • Nedap will request approval from the healthcare organization in the support portal.
    • If the request is approved by the healthcare organization, you will receive the signed PEM file in the support ticket, and you will see in the Ons API Dashboard that the request has been approved.

    You can now use this certificate to connect with the respective environment of the healthcare organisation.

Additional Information

Editability of versions
A supplier can only go through the certificate process for the staging and production environment when the version of the connector is approved and therefore uneditable. If the version has not been reviewed yet and therefore is still editable, then only certificates can be signed for the development environment.

Validity of 1 Year
A certificate is valid for 1 year after signing. It is the supplier’s responsibility to request/upload a renewed certificate in a timely manner. You can upload a new CSR in the Ons API Dashboard. Since permission has already been granted by the healthcare organisation, this does not need to be done again, and the CSR will be automatically signed. Nedap sends an automatic reminder email to the supplier about this one month before the expiration date.

Enable / Disable
If, for any reason, you do not want a connection to be made with the respective environment via a specific certificate, it is possible to disable it in the Enabled column. One possible scenario is if the certificate has been shared with unauthorized individuals. Disable access via the respective certificate, and link a new certificate by repeating all the above steps.