Step by step

This guide provides a step-by-step overview for integrating with Unico IDCloud services, covering authentication, SDK usage, service calls, webhook configuration and more.

Step 1: Define capability usage

Define which product capabilities will be required for your operation.

Step 2: Define the integration method

Decide whether the integration will be performed through by Unico or by Client and map the necessary communication points (APIs, SDKs, webhooks, callbacks, etc).

Step 3: Authenticate and obtain the access token

With your credentials, you must authenticate and obtain an OAuth2 access token. This token is required for all API requests.

  • Read more in the "Authentication" section of the chosen integration method.

Step 4: Implement SDK or Redirect (if applicable)

If you use our SDKs or Redirect, implement the respective methods.

Step 5: Implement webhook (if applicable)

If the integration requires asynchronous notifications, (1) configure the receiving endpoint on your server, (2) implement authentication (Basic Auth, APIKey, OAuth2 and/or IP restriction), (3) ensure processing is idempotent, avoiding duplication, and finally, (4) always have a fallback in case of service errors.

  • Read more in the "Webhooks" section of the chosen integration method.

Step 6: Implement service calls

Implement the calls necessary to consume the services. (1) All requests must be made server-to-server via HTTPS (TLS 1.2+) and (2) handle error responses (4xx, 5xx) consistently.

Recommendations & Best Practices

  • Use HTTPS/TLS in all communications.

  • Requests must always be server-to-server, due to our CORS policy, which prevents creating processes in a frontend-to-backend communication.

  • Prefer webhooks to receive the final result, avoiding continuous polling.

  • If you choose polling instead of webhook, implement an exponential backoff with jitter. (Exponential backoff progressively increases the wait time between attempts).

  • Do not rely on fixed polling — processing time may vary.

  • Use official SDKs to simplify capture and sending of data on the client.

  • Validate errors quickly — monitor error cases and handle failures (timeout, data invalidation).

Next steps

Last updated

Was this helpful?