Authorization

To work with "Gett business" API, you will need to have a relationship with Gett as a Customer or integrator on behalf of the customer(s).

Business API uses the OAuth 2.0 protocol for authentication and authorization. Business API supports Client Password authentication method.

Once the relationship is approved by Gett, you will be able to issue OAuth 2.0 credentials (Client ID, Client Secret) to authenticate with Gett. This data will be known by your client application and Business API server. The credentials are required to receive and refresh the authentication token.

To issue Client ID, Client Secret and get Business_id you need to visit Settings - Integrations setup in web portal with admin role. Ensure you're set as Contact in Settings.

Name

Description

Client_id

The ID corresponds to the Business API client.

Client_secret

Secret code required to get access token

Scope

Permissions granted for the token to get access to endpoints.

Business_id

UUID corresponds to the company. (given by Gett Support)

Authorization request

Your client application should use your client credentials to request an access token from the Business API auth endpoint. Other endpoints require an access token to get or manipulate data.

Authorization request params:

Name

Description

URL

https://business-api.gett.com/oauth/token

client_id

Client_id value is provided by Gett

client_secret

Client_secret value is provided by Gett

grant_type

client_credentials

scope

  • Values from scopes table.
  • Can have multiple values delimited by space symbol.
  • See the example below.

Scopes:

Scope value

Endpoints

order

Company settings
Products
Price estimation
Ride request
Delivery request
Get order details
Update Order
Cancel order

for both Ride and Delivery orders

company.reference

Add reference code

finance

Get order receipt and Business Reports API

employee

Employees management API

Authorization request example

Parameters:

curl -s 'https://business-api.gett.com/oauth/token' \
-F 'grant_type=client_credentials' /
-F 'client_id=92e0b95a-8690-4c26-b45b-5465af3a1bd7.13d08230-15ba-4016-9b6f-a4f495f80fe1' \
-F 'client_secret=my_secret_from_gett' \
-F 'scope=company.reference order'

Authorize response

{
  "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6InByaW1hcnkta2V5IiwidHlwIjoiSldUIn0.eyJhdWQiOltdLCJleHAiOjE2MTI3NzQ3ODU3VCBAr_jH73Nxd_1jv-VxRRFmLHan6qYOjxpXVswLxfKzGyBL__JbJ82IzycnDKCus5v3BbJuS-rMml13R-VYt8EzCdFD9JYjmpuyUQHxL7fl5MX5Ok_VbH9NZHOw0hCkCwwAjAfR2F2Wc2t1Mh5002RRGzE8d3KQ",
  "expires_in": 899, //seconds
  "scope": "company.reference order",
  "token_type": "bearer"
}

What’s Next
Did this page help you?