Go Live πŸš€

Follow this integration guide for a successful implementation:

1. Integrate the Widget

When integrating the Widget, ensure the following:

  • Your users first register an account with your application before accessing the flick Widget.
  • Customize the Widget to align with your branding.
  • Implement the Success and Close callback functions.
Announcement Box

   We recommend that you register your users on your own platform before implementing the widget.

2. Handle Errors

Ensure that your integration can effectively handle and log the request_id for the following error scenarios:

  • 400 and 401 errors
  • 500 Errors
  • Timeout errors
Announcement Box

   We recommend that you log the request_id in case you need to reach out to the support team.
        This ID can help speed up troubleshooting process.

3. Handle Responses

Make certain that your integration adequately manages:

  • 201 Success responses
  • Pagination: Refer to the API reference for details on how the Flick API returns paginated results.

4. Webhooks

If your integration involves recurring links, follow these steps:

  • Set up a webhook URL in the Dashboard to receive webhook events.
  • Request a refresh rate of 6 or 12 hours if necessary.
  • Only initiate GET requests after receiving a webhook event.

Ensure that you configure webhook URLs based on the environment you are utilizing. More information about Flick API environments is available in the API reference.

5. Statuses

Ensure your application actively monitors for invalid and token_required statuses, and prompt your users to update their credentials when needed.

6. Non-breaking Changes

Ensure that your integration remains unaffected by potential non-breaking changes in Flick's API, such as:

  • Introduction of new fields or changes in field order in the response body
  • Alterations in the length of character strings
  • Addition of new endpoints

7. URLs and API Keys

When launching your application, confirm the following:

  • You are making API calls to the production URL of the Flick API.
  • You are using production API keys.

For further best practices on interacting with the Flick API, refer to the API reference.