Skip to main content

Setup Uniform project

Goals

In Uniform, most of the settings that control layout for your web application are set and stored in a project. In order to configure these things, you need a project. This involves the following:

  • Understand what a Uniform project is.
  • Create a new Uniform project using the Uniform dashboard.
  • Understand what a Uniform API key is.
  • Create a new Uniform API key.

Create project

Projects are created and configured using the Uniform dashboard.

  1. Log into the Uniform dashboard at https://uniform.app

  2. Create the following project:

    • Project name: Intro to Canvas Tutorial
  3. The project dashboard page is displayed.

    Uniform project dashboard

Add API key

Your web application will need to read data and settings from the Uniform project. This requires a valid API key be assigned to the project, and for the right permissions assigned to the key. Learn more about roles and permissions.

  1. From the Uniform team home page, navigate to Security > API Keys.

  2. Add the following API key:

    • Name: Intro to Canvas Tutorial key
    • Project: Intro to Canvas Tutorial
  3. In the row for your Intro to Canvas Tutorial project, select the "..." to open custom permissions and select:

    Compositions > Read Draft
    Compositions > Read Published
  4. Click Use Custom Permissions.

  5. Click Create API Key.

  6. Three values are displayed, but we're only working with two: the API key and the project ID. Copy both of these values. You will need them later.

    apikey-displayed
    caution

    This is the only time the API key will be displayed. If you lose the value you will need to create a new one.