Push API tutorials

This is for:

Developer System Administrator
In this article

This section contains introductory, intermediate, and advanced Push API tutorials.

These tutorials assume that the reader knows how to make HTTP requests, and is familiar with REST interfaces and microservices in general.

Tutorial setup

You’ll need the following setup to begin the tutorials:

  1. A dedicated Coveo organization in which you have administrator privileges. We recommend that you create a free trial organization for this purpose.

    Note your organization ID as you’ll need it for the Push API requests. It appears in the URL when you’re in your organization.

    Getting the organization ID from the URL | Coveo

  2. A public Push source.

    1. In the Coveo Administration Console, access the Sources (platform-ca | platform-eu | platform-au) page.

    2. Click Add source.

    3. In the Add a source of content panel, select Push.

    4. Name your source.

    5. Click Add source.

    6. In the Make content accessible to everyone? dialog, check I understand and click Continue. This will make your source public. In tutorial 2, you’ll edit the source to make it secure.

    7. Note your source ID as you’ll need it for the Push API requests.

      Getting the source ID | Coveo

  3. An API key that grants you the privileges required to perform all tutorial HTTP requests.

    1. In the Coveo Administration Console, access the API Keys (platform-ca | platform-eu | platform-au) page.

    2. Click Add key.

    3. In the Add an API key panel, name your key.

    4. In the Privileges tab, grant the following privileges:

      • Content - Push documents to sources - Custom - Allow (on your new source)

      • Content - Push identities to security providers - Allow for all providers

      • Content - Sources - View

      • Content - Security identity providers - Edit

      • Organization - Activities - Edit

      • Organization - Organization - View

    5. Click Add key.

    6. Copy the key value to your clipboard and store it securely. You’ll need it for the Push API requests.

      Copying the API key value | Coveo

What’s next?

You’re ready to start the tutorials. You should do the three tutorials sequentially, as the outcome of one tutorial may be used as a prerequisite for the next one.

Proceed to Push API tutorial 1: Manage public content.