[LEGACY] API Keys — Previously: the REST API Connector

Owned by Yuri (Unlicensed)
Last updated: Oct 30, 2024 by Yuri Lapin
3 min read

Topics

Legacy statement

Customers before June 2023 had the option to connect their platform through a journy-proprietary REST API connector. This connector has meanwhile been replaced by a fixed settings page called "API access", due to the fact that the primary use is to query data out of journy.io.

If you still require back-end API connection to your platform, we highly recommend new customers to use our latest "SDK" connector, which is 100% compatible to Segment's SDKs. See The API/SDK Connector

Overview

If you need access to the data objects in journy.io, you can create API keys in journy.io's settings. The API calls itself are described in the following doc: https://developers.journy.io/#section/Backend and we have SDKs available for Node.js, PHP, and Python.

Typical use cases are: a custom dashboard in your platform, showing Stages, Health, Scores, Segments and other computed properties from journy.io.

How to create API Keys aka "Application"

Go to Settings → API access :

image-20240408-142637.png

When pressing the [+] button, following screen will appear:

image-20240408-142643.png

Here's what to fill in:

  • Name: The is the unique application name of API keys. This is mainly for UI and admin reasons throughout journy.io.

  • This application is allowed to:

    • Read contacts: If set, you can collect all user and account information, including all properties and events, encountered from all connected apps.

    • Read events: If set, you can collect event information defined in journy.io.

    • Read properties: If set, you can collect property information defined in journy.io.

    • Read segments: If set, you can collect segment information defined in journy.io.

    • Read campaigns (legacy): If set, you can collect campaign information defined in journy.io.

    • Read channels (legacy): If set, you can collect channel information defined in journy.io.

    • Retrieve tracking snippet for websites (legacy): This is the way to connect both UI-side/front-end (see [LEGACY] The JavaScript Connector) and server-side/back-end integration. Only possible when the option is switched on.

    • Track events, create and update contacts (legacy): If set, you can create and update users and accounts, their relationship as well as trigger events on users, on accounts and on unique combination of both user and account.

Upon pressing 'Create Application', you'll receive your unique API key to be used with out SDKs. Learn how on: https://developers.journy.io/#section/Backend/Authentication

Review API connector settings

When hoovering over the API Keys/Applications, you will see 3 icons: Logs, Edit and Delete. When pressing Edit, you'll see the following:

The 'Enable' switch allows you to turn on and off the API Key (without needing to delete or change API keys).

All other options are the same as when you connect, on top of being able to 'Regenerate' a new API key.

IMPORTANT: For extreme security reasons, there is no way to retrieve your API keys. You have to copy them somewhere safe when generated...or regenerate them.

Review API Key Logs

As previously mentioned, when hoovering over the API Keys/Applications, you will see 3 icons: Logs, Edit and Delete. When pressing Logs, you'll see detailed logs on anything that has been sync'ed between journy.io and your application.