Skip to main content

Connecting Your App

An App Registration represents an application that can access data in your SyncHive hive. During registration, you define which shapes the application can use and where the application is hosted.

Registering an App​

To create an App Registration:

  1. Open Connect and select Apps.
  2. Select Register App.
  3. Enter a name for the application.
  4. Select one or more shapes.
  5. Leave the status as Enabled.
  6. Save the registration.

Assigning Shapes​

Every app registration must be assigned one or more shapes.

Shapes determine the data structures available to the application and define the information that can be exchanged through SyncHive.

An application can be assigned multiple shapes, and the same shape can be used by multiple applications.

Connection Details​

Once the app registration has been created, SyncHive generates a ready-to-use prompt snippet with a publishable key for connecting your application.

Option 1: Copy the generated prompt snippet​

This is the recommended approach. The generated snippet already includes the publishable key, assigned shapes, and instructions for connecting to SyncHive. Paste the snippet into your AI coding tool and describe the application you want to build.

Option 2: Copy the publishable key only​

Use the key directly if you prefer to write your own prompt or configure the connection manually.

Application URLs​

App Registrations can include one or more application URLs.

These URLs identify where the application is hosted and are used by SyncHive when validating application access.

When creating a new application, it is common not to know the final application URL yet. In this case, you can leave the App URL(s) field empty and update it later.

Many application development platforms generate temporary or preview URLs while an application is being built. These URLs may change during development and are often different from the URL ultimately used when the application connects to SyncHive.

Once the application has been deployed and is ready to connect, update the App Registration with the application's current URL.

If an application cannot connect successfully, one of the first things to verify is that the URL being used by the application has been added to the App Registration.

Troubleshooting​

App URLs​

If your sign-in does not work, the most common cause is an App URL mismatch.

When this happens, you will see:

Access Denied
The app has not been registered in SyncHive to use the following URL...

This means the app URL you entered in SyncHive does not exactly match the URL your app is using during sign-in.

Common issues​

A missing or extra slash​

Entered in SyncHive:

https://my-app.com/sign-in

App is using:

https://my-app.com/sign-in/

http vs https​

Entered in SyncHive:

https://my-app.com/sign-in

App is using:

http://my-app.com/sign-in

Different web address​

Entered in SyncHive:

https://portal.my-app.com/sign-in

App is using:

https://my-app.com/sign-in

Different path or capitalization​

Entered in SyncHive:

https://my-app.com/Sign-In/

App is using:

https://my-app.com/sign-in/

How to fix​

  1. Copy the URL provided to you on the Access Denied page.
  2. Open Apps in SyncHive and select your app.
  3. Paste the URL you copied on the Access Denied page into one of the App URL(s) fields.
  4. Save your changes.
  5. Try signing in again.