0%

How to Send Data to Plecto's API

What is Plecto API?

The Plecto APIΒ allows developers to create a custom advanced integration that enables other software to communicate with our platform and export their data to Plecto.

Authentication

  • The authentication scheme used for the Plecto API is Basic Authentication. It includes sending your email and password along with the request.

  • Tip! πŸ’‘ We recommend creating a new user (new employee profile) per integration in your Plecto organization – this way, you'll avoid sharing the same password across integrations.

  • The user must have access to the relevant areas of Plecto to succeed with most API endpoints. If your Plecto subscription includes advanced permission management, you can create a specific permission profile for the user account.

To create new employees, go to Settings > Employees > New employee in Plecto or add them through an API request.

Base URL and Endpoints

All Plecto API endpoints are listed under the following base URL:Β https://app.plecto.com/api/v2/

This URL is the basis for all endpoints of the Plecto API. If you are logged into your Plecto account, you can see the list of API endpoints directly in the browser.

How to create an API data source

You can create an API data source in two ways:

  • Post a request to this endpoint: https://app.plecto.com/api/v2/datasources/
    It is enough to include "title" and "fields" keys in the request to create the data source.

  • Or go to Data sources > New data source > Plecto API and create a new data source from the Plecto interface.

Adding more fields

If you need to add more fields to your API data source, you'll have to do it through the UI in your data source settings. We currently don't support updating fields via the API.

Adding registrations: Mandatory keys

Endpoint: https://app.plecto.com/api/v2/registrations/

Mandatory keys to include for each registration

There are 3 mandatory keys that must be included in the request body for every API request that you send. The keys are the following:

  1. data_source,

  2. member (or member_api_provider, member_api_id, and member_name), and

  3. external_id.

#1

data_source

The data_source key requires your data source's UUID.

The UUID is an alphanumeric string that you can find in the URL when you open a data source.

#2

Choose one or the other

member

Using member UUID requires having an existing employee profile in Plecto.

To find the member UUID, go to the Employees page and click on a name. You'll see the UUID in the URL.

member_api_provider

member_api_id

member_name

With this option, Plecto might create new employee profiles when you send the data, and the employee will continue to be managed by your system.

  • member_api_provider refers to the name of your system. In the image below, the displayed system name is Postman.

  • member_api_id refers to the member ID of your system. In Plecto, it is displayed under the External ID field. In the image below, 101032 represents the member_api_id. The member_api_provider and member_api_id together identify an employee in Plecto.

  • member_name is the name of the member. This name will be displayed in the Employee field in your Plecto data source and can be updated, provided that you use the same member_api_provider and member_api_id values.

#3

external_id

The external_id is a number or a string of characters that has to be unique for each registration. It could be something like 123, abc or anything you can think of. This is important as it will be the reference of the created registration. The external ID values in your request body are displayed in the "ID" field in your Plecto data source.

Naming conventions – don't get confused!

  • The member_api_id key in your request body represents the External ID shown in the employee profile in Plecto, and the external_id key represents the Registration ID in a Plecto data source.

Bulk registrations

  • If you want to assign multiple registrations to the same user, you can use the same member_api_id. However, the external_id key needs to be different for each registration, unless you want to overwrite an existing registration with new data.

Basic example: Adding registrations via API

Let's send new registrations to a Plecto data source!

  • The request to create a registration in a data source has to use the URL for the registrations endpoint, which is the following:Β https://app.plecto.com/api/v2/registrations/

  • The POST request body must include the mandatory keys plus a key called "Value," since the data source in Plecto has a custom field added to it called Value.

If the authentication passes and the request is correct, Plecto will accept the registration and return a successful response. In the response, the "id" is the UUID of the newly-created or updated registration in Plecto.

Bulk insertion

The Plecto API supports sending a list of registrations in a single request body. However, the API also enforcesΒ a limit of 100 registrations you can send in a single request.

Above is an example of what a request body could look like.

How to update existing data via API

Endpoint: https://app.plecto.com/api/v2/registrations/

  • The data_source and external_id identify a registration in a data source in Plecto. The external_id represents the registration ID in Plecto. If you want to update the registration values, send a request using the same data_source and external_id keys but change the field values.

  • The member_api_provider and member_api_id identify an employee in Plecto. If you want to update the employee name, you can send the same request but change the member_name value from, for example, "Employee X" to "Curtis Miller."

  • You can send a date field to Plecto (optional). It will show in the Created date field in your data source. Whenever you send a registration, Plecto automatically adds the current date and time to it. If you want to update a registration but keep the original date and time, add the following key to your request body: "date": "2022-12-31T10:22:55"

0%