Skip to main content

How to Integrate With Our API

This guide helps you get started with using our API and effectively integrate your systems.

Updated over 10 months ago

Using our API

Before you can start integrating with Uniify, you need to have a Team registered on our platform and a Uniify user account. We handle the setup, ensuring you have full access to your team.

Configuring API Key and Webhook

API Key:

We use the bearer token method for authentication. This method assigns each user a unique token, which is used to access protected resources without sending a username and password for each request, enhancing security.

Instructions:

To generate a unique bearer token for your team, navigate to Settings → API in Uniify, create a new token, and select both read and write permissions.

Webhook:

To set up webhooks, see our article Setting Up Webhooks. Once you have set up webhooks and generated a token, you are ready to use the API.


Getting Started

  1. Create a Case with a POST Request:

    • Define two body parameters: a generic case_type_code and a label representing the case name..

    • Update case_type_code based on the flow type you want to call (Individual or Company).

    • Include flow_code in the entity object to specify the flow to be used. This can be found on the platform.
      ​

  2. Webhook-svar:

    • Efter ovenstående trin skulle webhook'en give svaret "COMPLETED", hvis operationen er fuldført.
      ​

  3. Retrieve Data with a GET Request:

    • Use the get_entity_flow GET request to retrieve all data from a given case.

    • Define three path parameters: case_code, entity_code (representing an individual or company), and entity_flow_code (a unique ID linking the individual entity to the associated flow). All three parameters are returned in the previous POST request.

Related Articles
Understanding User Roles and Permissions
Did this answer your question?