Client Empowerment: API Keys

Owned by Bettina Lippisch
Last updated: Sep 16, 2024 by Alyssa Sands
3 min read

Knowledge Base Home

Search the Omeda Knowledge Base

API Keys Dashboard

In the API Keys section of the Manage Database tool, users with access can view, edit, and create the API Keys used for their database.

An API key is a unique identifier used to authenticate requests associated with your database. It serves as a means to control and monitor access, ensuring that only authorized users can access and interact with your database or service. Because of their potential power and the access they grant, API keys should be handled with great care.

image-20240624-192827.png

In the table on the dashboard, you’ll see information about each API Key including:

  • A truncated view of the API Key

  • A description of how the API Key is used.

  • The user who last modified the API Key

  • The date of the last modification

  • The date the API Key expires

  • And the status of the API Key

On this screen users can also:

 

  • Confirm the brand abbreviation that should be used for API calls in the bold text below the page title.

  • Edit or view the settings of an API Key by clicking the Edit icon

  • Create a new Alternate ID

Creating an API Key

image-20240624-192837.png

When you click Create + you will be navigated to the New API Key page. Here you will need to provide the following:

  • Description : A brief description of the purpose of the API Key as well as the vendor or third party who will be using it.

  • Expiration Date : The date the access for the API Key should expire.

  • and the API Services the API Key should be able to access.

API Services

API Services refer to the endpoints and actions available at those endpoints that owners of the API Key can use. They are divided into seven sections:

  1. Customer Lookup : these APIs generally require a customer ID and return information about a single customer.

  2. Store Customer Info : these APIs allow a customer to be created or updated.

  3. Brand Lookup & Store : these APIs provide database level information about demographics, behaviors, products, and more.

  4. Email Builder : these APIs can be used to create and manage Email Builder deployments.

  5. Utility : these APIs enable users to Run Processor, lookup Form Submissions, setup Zapier access and more.

  6. Olytics : these APIs provide information about an audience member’s visit behavior, the top visited attributes for an audience member and more.

  7. Authentication : these APIs support website authentication workflows like registration, login, username/password updates and more.

Once you’ve selected the appropriate API Services the API Key should have access to, you can click to copy the API Key and create. The API Key can then be securely shared, along with documentation for each API Service, with the technical resource completing the integration. If the integration will be using POST APIs to send data to Omeda, you will need to request an input from Omeda’s support team.