APIs are created in BidClips to connect with the Zapier application based on triggers and actions.
Connect Zapier to BidClips
-
API endpoint: https://providers.bidclips.com/api/oauth2-connect
-
Method: GET
-
URL Params:
-
client_id: zapier client id
-
state
-
redirect_uri: redirect URL
-
response_type : string
-
-
Response: gives you a redirect page
BidClips JWT Token
-
API endpoint: https://providers.bidclips.com/api/authenticate/provider
- Method: POST
- Body:
{
'username': bidclips_user_name,
'password': bidclips_user_password,
'remember_me': false,
}
- Response:
{
'jwtToken': {
'id_token': "jwt_bearer_token"
},
'providerUser': {
'id' : 'provider_user_id',
...other provider user details
}
}
Store jwt_bearer_token and provider_user_id for future reference.
BidClips oAuth Token for Zapier
- API endpoint: https://providers.bidclips.com/api/oauth-access-token
- Method: POST
- Headers:
- Authorization: Bearer {jwt_bearer_token}
- Body:
{
'code': 'generated code',
'client_id': 'zapier client id',
'client_secret': 'zapier client secret',
'redirect_uri': 'zapier redirect uri',
'grant_type': 'code'
}
- Response:
{ 'access_token': 'bidClips_oauth_bearer_token', 'refresh_token': 'bidClips_oauth_refresh_token', ...other data }
Copy bidClips_oauth_bearer_token and past it to the below API for getting the BidClips document.
GET BidClips documents
- API endpoint: https://providers.bidclips.com/api/zapier/trigger/performList
- Method: GET
- Headers:
- Authorization: Bearer {bidClips_oauth_bearer_token}
- URL Params:
- trigger_type: job/customer
- Response for job:
Field |
DataType |
Description |
---|---|---|
id |
string |
job id |
customer_name |
string |
name of customer for job reserved |
customer_phone |
string |
phone no of customer for job reserved |
customer_email |
string |
email of customer for job reserved |
job_status |
string |
status of job |
schema_version |
number |
schema version number of job object |
shop_name |
string |
name of the shop |
service_name |
string |
name of the service |
bid_id |
string |
service request id |
quote_id |
string |
quote id |
addon_total |
number |
total of addons |
discount_total |
number |
total of discounts |
discounts |
array |
array of objects, fields are title and discount value |
tax_total |
number |
total tax for the job |
wait_preference |
string |
wait preference |
job_created_date |
Date/Time |
date when job is created |
job_created_by |
string |
name of the person who created job |
job_updated_date |
Date/Time |
date when last updated job |
job_updated_by |
string |
name of the person who updated job at last |
payment_status |
boolean |
is payment done towards the job |
payment_desc |
string |
payment description if payment is done towards the job |
travel_surcharge |
string |
travel surcharge amount |
technical_assigned |
string |
name of the technical person for that job |
grand_total_with_insurance |
number |
grand total with insurance |
job_confirm_bid |
string |
job confirm bid |
job_confirm_with |
string |
job confirm with |
reserve_date_start_time |
Date/Time |
job reservation start time |
reserve_date_end_time |
Date/Time |
job reservation end time |
job_grandTotal |
number |
job grand total |
request_ref |
string |
request ref of service request |
service_location |
string |
location of service |
customer_location |
string |
location of customer |
shop_location |
string |
location of shop |
Response for customer:
Field |
DataType |
Description |
---|---|---|
id |
string |
unique id for customer |
customer_name |
string |
full name of customer |
emails |
array |
multiple emails |
phones |
array |
multiple phone numbers |
notes |
string |
note |
company_name |
string |
company name if any |
shop_name |
string |
name of shop |