MyCashflow REST API enables you to integrate your online store with third-party apps, such as CRM, or with accounting or bookkeeping software.

You need programming skills to use API. By using API in your online store, you can develop an API client for transferring data between your online store and your required external application.

MyCashflow API is available in the following plans:

  • Advanced
  • Pro
  • Enterprise

Pricing

Using the extension is free of charge.

Enablement

First, enable the API extension in your online store.

  1. Log in to your online store's admin dashboard at https://STORE-NAME.mycashflow.fi/flow, if you are not logged in yet.
  2. Via the top menu bar go to Account > Apps > API.
  3. Click Order now.

The API extension is now enabled in your online store. Next, create API users to use with API clients.

Creating API users

In the API user details, define the credentials that are to be used for logging into an API client. For each API client, you may want to create a separate API user.

  1. Via the top menu bar go to Account > Users.
  2. In the left-hand API credentials pane, click Create account.
  3. Enter the integration's name and the API user's email address.

    The email address will be used as the API username combined with an API key. Learn more about API keys ›

    For detailed information about API client authentication, see API documentation.

  4. Click Save.

    Copy the API key as soon as you have finished creating the user.

    The API key is shown only once after creating the user.

    If you misplace the API key, you can generate a new one in the API user form.

API keys

An API key is automatically generated upon the creation of an API user. The API key is shown only once after creating the user. However, you can generate new API keys for the user when necessary.

The API key is used as a password during call authorization. For detailed information about API client authentication, see API documentation.

To create a new API key for a user:

  1. On the Account > Users page, open the API user's details for editing.
  2. Select Generate new API key.
  3. Click Save.

The new API key can be found in user details after the user details have been saved. Copy and save the key, as it is shown only once.