{"info":{"_postman_id":"6f692f05-dbbe-40de-8658-94bb39b0308f","name":"API Documentation","description":"

🚀 This is the official API Version 1.0.0!

⚙️ API are useful to automate processes!

For example, you can automate the process of adding new seats, or automate review invitations!

AUTHORIZATION:

HOW TO FIND YOUR API TOKEN:

Log in into the webapp
Go to 'Settings' on the top-right corner
Click on 'Automate'
Click copy on the 'x-api-key'

HOW TO FIND YOUR SEAT ID:

Log in into the webapp
Go to 'Settings' on the top-right corner
Click on 'Automate'
Click on 'Seat ID' to copy the selected ID you want to use

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25285435","collectionId":"6f692f05-dbbe-40de-8658-94bb39b0308f","publishedId":"2s8ZDR6QWW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"25D366"},"publishDate":"2023-01-11T10:03:01.000Z"},"item":[{"name":"Seats","item":[{"name":"Create new seat","id":"e73939d0-717e-45ab-9e72-a9220abdaaf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50X2lkIjoiNjAyNGYwMjIzYmJiOTQ0NGZkNjc5MmY1Iiwic2VydmVyX2VudiI6IkRldiIsInNlcnZlcl91cmwiOiJodHRwOi8vbG9jYWxzaG9zdDo1MDAwL2FwaS92MC4wLjkifQ.ah6xHZffAUBRbGQi7tyDaTM_JbMnOcBmov74Tjl9vrY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"seat_name\": \"test-country-papi1\",\n \"email\": \"tiniyat140@hraifi.com\",\n \"password\": \"blablabla\",\n \"full_name\": \"Gianluca\",\n \"country\":\"ES\"\n}","options":{"raw":{"language":"json"}}},"url":"https://server.onlinereviews.tech/public-api/v1.0.0/seat/add","description":"

This call allows you to automatically add a seat and associate it with a new user.

If you have reached the maximum quantity of seats for your account, this call will automatically increase the number of seats in your subscription.

BODY DESCRIPTION:

seat_name:required, string

The name of the new business you want to add.

email:required, string

Email of the new user: the new user will have access to only this seat. If you want to grant this user access to multiple seats, you have to repeat this call with the same email account.

password: optional, string

If you don't pass this field, the password will be generated by our system and will be communicated to the user via email with the new credentials. If passed, we will use your password instead.

full_name: required, string

Full name of the new user you want to give this seat access.

purchase: optional, boolean,

Default to true. If you dont want to automatically purchase another seat if you've reached the maximum quantity for your subscription, please pass this parameter with the value false. If you purchased an \"unlimited clients\" account, you will not be charged.

email_subject: string,

The subject of the welcome email.

email_text: string,

The text of the welcome email.

If you want your client to receive a custom email, please add this field to the body and the customer will receive a custom email. Notice we will automatically add his credentials after your text.

RESPONSE DESCRIPTION:

{\n    \"seat\": \"\",\n    \"message\": \"\"\n}\n\n

seat: string,

It contains the seat id.

message: optional, string

It contains information about the API call.

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","seat","add"],"host":["server","onlinereviews","tech"],"query":[],"variable":[]}},"response":[],"_postman_id":"e73939d0-717e-45ab-9e72-a9220abdaaf8"},{"name":"Switch client plan","id":"c83144d1-3153-4d16-9e08-26248860a02c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"plan_name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/public-api/v1.0.0/seat/custom-plan","urlObject":{"path":["public-api","v1.0.0","seat","custom-plan"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c83144d1-3153-4d16-9e08-26248860a02c"}],"id":"651acc95-d98b-4128-af7b-ab7c5e53d315","description":"

This endpoint will allow you to create a new seat with a new user associated. It is useful to automate the process of adding new clients or locations!

We improved the response message of this api call, you will get better explanation when encountering an error.

Best practise:

Do not add yourself or an admin, as you will get an error.
If you try to add a user whose email is already in the our app but associated with a different account you will get en error
Make sure you used all the required parameters before making this call.

Note that if you want to add more seat to one of your user you can do it by calling this endpoint with a different seat_name but the same email address.

\n","_postman_id":"651acc95-d98b-4128-af7b-ab7c5e53d315"},{"name":"Review Invitations","item":[{"name":"Schedule review invitation","id":"00c74609-504a-4a9a-ac4a-9a1f616aecb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"YOUR-API-TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"send_datetime\":\"2021-09-23T15:52:55+02:00\",\n \"retry\":3,\n \"template\":{\n \"subject\":\"Ciao {{name}}\",\n \"html\":\"test {{name}} {{company_name}} {{review_link}}\",\n \"text\":\"test {{name}} {{company_name}} {{review_link}}\"\n },\n \"name\":\"Marco\",\n \"email\":\"mattamarco88@gmail.com\",\n \"user_defined_id\":\"xxx\",\n \"seat\":\"{{seat_api}}\"\n}"},"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/invitation","description":"

BODY DESCRIPTION:

send_datetime: Required, DateTime

e.g. \"2023-09-23T16:10:55+02:00\"

When you want the invitation to be sent.

At the moment is supported only UTC format

retry: Optional, Int, default: 0

How many time do you want to re-send this invitation if the client does not click on the review link.

Max 3 times

Template: Required, Dict

If you want to use the email template of your acount please pass this:

{\n\"id\": \"default\",\n\"locale\": \"en\"\n}\n\n

id: Pass \"default\" for using the email template of your account
\n
locale: The language you want the template to be sent
\n
- At the moment the supported languages are: it, en, de, es, fr, pt, pl, no, nl, dk
\n

If you want to use a custom template use this format instead:

{    \n\"subject\":\"Hi {{name}}\",\n\"html\":\"test {{name}} {{company_name}} {{review_link}}\",\n\"text\":\"test {{name}} {{company_name}} {{review_link}}\"\n}\n\n

subject: String
- The subject of the email
\n
html: String
- The text of the email: any parameters will need to be inside double brackets
\n
text: String
- The text of the email: any parameters will need to be inside double brackets
\n

name: Required, String

Name of the client you want to send the invitation to.

email: Required, String

Email of the client.

user_defined_id: Optional, String

If you pass this parameter, as a response to a successful invitation, we will send you back this ID, as a tracking method

seat: Required, String

The ID of the seat

You can find this ID in the Account -> Automation & then copy the ID of which seat you want to send invitation from

RESPONSE DESCRIPTION:

{\n    \"id\": \"\",\n    \"tracking\": \"\",\n    \"send_datetime\": \"\",\n    \"retry\": \"\",\n    \"template\":{},\n    \"name\": \"\",\n    \"email\": \"\",\n    \"user_defined_id\": \"\",\n    \"idempotency_id\": \"\"\n}\n\n

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","invitation"],"host":["server","onlinereviews","tech"],"query":[],"variable":[]}},"response":[],"_postman_id":"00c74609-504a-4a9a-ac4a-9a1f616aecb1"},{"name":"Delete review invitation","id":"53ac0e41-799a-4133-848e-79bcd0ec273a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"YOUR_API_TOKEN","type":"text"}],"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/invitation/:invitation_id","description":"

Delete the invitation.

PATH VARIABLES DESCRIPTION:

invitation_id: Required, String

The ID of the Invitation.

This ID is the id given as response in the previous endpoint.

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","invitation",":invitation_id"],"host":["server","onlinereviews","tech"],"query":[],"variable":[{"type":"any","value":null,"key":"invitation_id"}]}},"response":[],"_postman_id":"53ac0e41-799a-4133-848e-79bcd0ec273a"},{"name":"Get review Invitation","id":"cb694892-cb6e-43a0-aaf9-00549b9be27a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_TOKEN","type":"text"}],"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/invitation/:invitation_id","description":"

Get invitation description.

PATH VARIABLES DESCRIPTION:

invitation_id: Reqiured, String

The ID of the invitation.

RESPONSE DESCRIPTION:

{\n    \"id\": \"\",\n    \"tracking\": \"\",\n    \"send_datetime\": \"\",\n    \"retry\": \"\",\n    \"template\":{},\n    \"name\": \"\",\n    \"email\": \"\",\n    \"user_defined_id\": \"\",\n    \"idempotency_id\": \"\"\n}\n\n

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","invitation",":invitation_id"],"host":["server","onlinereviews","tech"],"query":[],"variable":[{"type":"any","value":"","key":"invitation_id"}]}},"response":[],"_postman_id":"cb694892-cb6e-43a0-aaf9-00549b9be27a"},{"name":"Get review stats","id":"a6bdc6db-a8d6-4b9f-a2a3-5b6a024e2450","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://server.onlinereviews.tech/public-api/v1.0.0/review/stats/:seat_id","description":"

Return reviews stats of your seats.

PATH VARIABLES DESCRIPTION:

seat_id: Required, String

The ID of the seat.

You can find this ID in the Account -> Automation & then copy the ID of which seat you want

\n","urlObject":{"protocol":"https","path":["public-api","v1.0.0","review","stats",":seat_id"],"host":["server","onlinereviews","tech"],"query":[],"variable":[{"type":"any","value":null,"key":"seat_id"}]}},"response":[],"_postman_id":"a6bdc6db-a8d6-4b9f-a2a3-5b6a024e2450"}],"id":"b62d9d22-bde8-4d5b-ba4b-7e392d95f3da","description":"

Automate the review invitations.

This endpoint will give you the opportunity do create & delete review invitation.

\n","_postman_id":"b62d9d22-bde8-4d5b-ba4b-7e392d95f3da"}]}