Authentication

To access the PingUp APIs, you must first create an account. Follow these steps to get started:

1

Create an account

If you haven't done so already, please register for an account on the PingUp platform.

2

Access your settings

Once you have created your account, log in to the PingUp dashboard. Navigate to the Settings section of your account. This is where you can manage your API access and configurations.

3

Obtain required parameters

In the Settings section, you will need to locate the following parameters:

  • Business Name: This is the name of your business as registered with PinguP. It is required for identifying your account and you need to use it in the endpoint

  • Secret Key: This token is crucial for authenticating your API requests. You can generate or view your access token in the settings.

4

Start using API

With your Business Name and Secret Key, you can now authenticate your requests to the PingUp APIs. Be sure to include the access token in the Authorization header of your API calls.

Production Endpoint

When making requests to the API, include the Business Name as follows:

Endpoint: https://api.pingup.ai/ext/v2/{{businessname}}
Authorization: Bearer your_secret_key

Try to get user informations

User Info

Important Notes:

  • Keep your Access Token secure and do not share it with unauthorized individuals.

  • If you suspect that your Access Token has been compromised, please regenerate it immediately from your account settings.

Last updated