Getting started

In this section, you will learn how to get started with the Oneflow public API.

Step 1. Create a Oneflow account

Start your work by creating a Oneflow account.

📘

Note:

If you're new to Oneflow, go to the Oneflow application and create a trial account.

Step 2. Generate an API token

Once you’ve created an account, you’ll need an API token:

1. Log in to Oneflow.
2. Go to Admin > Account > Extensions page and enable the API tokens extension:

3. When enabled, click the API tokens link and click Generate a new token.

4. Name your new API token and click Confirm.

5. Copy the token and securely save it for future use.

📘

Note:

The token is shown only once.

Step 3. Make the Oneflow API ping request

Now check your connection and authentication via the ping request below.

Please replace the API_TOKEN with your API access token you generated in step 2.

curl -X GET 'https://api.oneflow.com/v1/ping' \
-H 'x-oneflow-api-token: API_TOKEN'

import requests

headers = {
    'x-oneflow-api-token': 'API_TOKEN',
}

response = requests.get('https://api.oneflow.com/v1/ping', headers=headers)

Step 4. Evaluate response

If everything went well, you should get an HTTP response with an empty JSON object ({}) in the response body.

Next steps

Now you are ready to start building your automation workflow!

It may be good to start with getting a single contract from Oneflow. Please proceed to the Tutorials section to read our how-to articles.

Otherwise, please read the Authentication and authorization section and look at the list of available endpoints in the API Reference documentation.