How to integrate with out API

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

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 transmitting a username and password for every request, thereby increasing security.

How to set it up:

1. Log in to Uniify.

2. Go to Settings and find the API section.

3. Click on Generate token.

4. Give your token a name (e.g., "CRM integration") and select the permissions Read and Write.

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

Create a case with a POST request:

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

2. Update the case_type_code depending on which flow type (Individual or Business) you wish to trigger.

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

Webhook Response:

1. After the steps above, the webhook should return the status "COMPLETED" if the operation is successful.

Retrieve data with a GET request:

1. Use the get_entity_flow GET request to retrieve all data from a specific case.

2. Define three path parameters: case_code, entity_code (representing an individual or business), and entity_flow_code (a unique ID connecting the individual entity with the associated flow). All three parameters are returned in the preceding POST request.

Need help with the integration?
If you experience issues with your API token or if the documentation raises any questions, we are ready to help. Reach out via chat or at support@uniify.io, and we’ll help your technical team get started.