Bringg

Bringg Services

About Bringg Services

Bringg Services are unique URLs that merchants can create and use without authentication instead of regular Bringg API calls. Bringg Services do not require authentication, because each Bringg Service URL is composed of three GUIDs that Bringg generates when a merchant creates a Bringg Service. The GUIDs ensure secure requests without authentication.

Bringg Services Are Secure Without Authentication

Every Bringg Service URL is a unique combination of three GUIDs effectively creating a user name and password. Using secured networking (SSL) and this combination of three GUIDs, every Bringg Service is secure.

General Form of a Bringg Service

The general form of a Bringg Service is the following:

https://admin-api.bringg.com/services/{serviceId}/{service_uuid1}/{service_uuid2}/

where {serviceId}, {service_uuid1}, and {service_uuid2} are GUIDs (universally unique) created by Bringg for each service.

Merchants create Bringg Services using the name of the endpoint action for which a service is required. Bringg then generates the unique Bringg Service URL. For example, a merchant can create unique Bringg Service URLs for Create Order, Update Order, and Cancel Order. That merchant's Bringg Service URLs for Create Order, Update Order, and Cancel Order are different than all other Bringg Services for any merchant.

All Bringg Services are POST Methods

Bringg Services POST methods are different than other API POST methods.

Bringg Services may require:

  • input parameters in the body, only

Bringg Services return a response:

  • output parameters

Bringg Services do not require:

  • path parameters in the URL
  • collection names in the URL
  • Ids in the URL

Using Bringg Tags with Bringg Services

Use Bringg Tags with Bringg Services URLs by either of the following methods:

  • the same Bringg Tag for every execution of the URL - assign a Bringg Tag when you create a Bringg Service URL.
  • a different Bringg Tag for each execution of the URL - use the tag_id parameter in the body when you use a Bringg Service URL.

NOTE: You can create more than one Bringg Services URL for the same action and use different Bringg Tags for each.

Creating Bringg Services

Create Bringg Services using the endpoint action names for which you require a service. For example, use the endpoint action names Create Order to create a Bringg Service for Create Order. No additional configuration in Bringg is required.

To Create a Bringg Service:

  1. In your company profile, go to Webhooks & API.
  2. Click the API tab. The API panel appears.
  3. At the bottom of API panel, in the API Type, Action list, click your required endpoint action names.
  4. If required, in the Optional Tag text box, type the name of a Bringg Tag to use with all executions of this Bringg Service (see, Bringg Tags).
  5. Click Add Service. The new Bringg Service is created. The Bringg Service URL appears in the alphabetized list of Bringg Services.

Multiple Bringg Services for the Same Endpoint Action

You can create more than one Bringg Service URL for the same endpoint action. Each Bringg Service URL can use a different Bringg Tag.

Finding Bringg Service URLs

If the required Bringg Service URL was previously created, you can find the URL in the list of Bringg Service URLs.

To find a Bringg Service URL:

  1. In your company profile, go to Webhooks & API.
  2. Click the API tab. The API panel appears.
  3. Locate your required Bringg Service URL in the alphabetized list of services.

Deleting Bringg Services URLs

Delete a Bringg Service URL.

To delete a Bringg Service URL:

  1. In your company profile, go to Webhooks & API.
  2. Click the API tab. The API panel appears.
  3. In the required Bringg Service URL row, click the red delete button. The Bringg Service URL is deleted.

List of Bringg Services

The following is a list of the Bringg Services.

Bringg Service Name
Description

Update an order (task) that the driver arrived at the next location (check in).

Cancel an order (task).

Create a new customer.

Create a note for a way point.

Create a new order (task).

Create a new team.

Create a new user (driver, dispatcher, or admin)

Delete a team.

Delete a user (driver, dispatcher, or admin).

Returns a message indicating whether a driver got home or left home.

(The reference page documentation for this service is currently being updated).

End order (task).

End the shift of a user (driver).

(The reference page documentation for this service is currently being updated).

Get the details of a team.

Get the details of a user (driver, dispatcher, or admin).

(The reference page documentation for this service is currently being updated).

(The reference page documentation for this service is currently being updated).

(The reference page documentation for this service is currently being updated).

(The reference page documentation for this service is currently being updated).

(The reference page documentation for this service is currently being updated).

(The reference page documentation for this service is currently being updated).

(The reference page documentation for this service is currently being updated).

List all opened orders.

List all post optimization orders.

Start the shift of a user.

Start an order.

Update a customer's details.

Update an order's (task's) details.

Update a team's details.

Update a user's details.

Bringg Services