Skip to main content
API docs by Redocly

Road Assistance Api (1.0.0)

Download OpenAPI specification:Download

Swagger Road Assistance Api

Nomenclature

Nomenclature

List of countries

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List of counties

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List of localities filtered by county code

path Parameters
county_code
required
integer

County code

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "false",
  • "status": "200",
  • "data": [
    ]
}

List of vehicle makes

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "false",
  • "status": "200",
  • "data": [
    ]
}

List of models filtered by make ws id

path Parameters
make_ws_id
required
integer

Make ws id

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "false",
  • "status": "200",
  • "data": [
    ]
}

List of Packages

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List of Currencies

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List of Vehicle Usage Types

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List of Vehicle Fuel Types

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List of Vehicle Types

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Products

Products

Get a quote

A quote is obtained from the insurer for the product specified in the request.

header Parameters
Token
required
string
Request Body schema: application/json
required

JSON format body

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "provider": {
    },
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Download offer

Download offer in PDF format

path Parameters
id
required
integer

Offer identification number

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Policy PDF file

Retrieve policy PDF file

query Parameters
series
required
string
Example: series=XX/12/12

Policy series

number
required
string
Example: number=1234567890

Policy number

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Transform the offer into a policy.

The offer is transformed into a policy based on the offer identifier.

header Parameters
Token
required
string
Request Body schema: application/json
required

JSON formatted body

offerId
required
integer
required
object

Responses

Request samples

Content type
application/json
{
  • "offerId": 6,
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Download policy

Download policy in PDF format

path Parameters
id
required
integer

Policy identification number

header Parameters
Token
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get product details

Returns product details including packages. If amount and currency are null, the price is dynamic.

query Parameters
company
required
string
product
required
string

Responses

Response samples

Content type
application/json
{
  • "company": "pointer",
  • "product": "road_assistance",
  • "packages": [
    ]
}

Authentication

Authentication

Authenticate

Authenticate an account by account/password

query Parameters
account
required
string

Account

password
required
string

Password

Responses

Response samples

Content type
application/json
{
  • "error": "false",
  • "status": "200",
  • "data": {
    }
}

Deautenticate

Deautenticate an existing and valid auth token

Responses

Renew token

Renew an authentication token

header Parameters
Token
required
string
Example: Refresh [refresh_token]

The Refresh token received from the POST /auth or PATCH /auth endpoint's response field name refresh_token.

Responses

Response samples

Content type
application/json
{
  • "error": "false",
  • "status": "200",
  • "data": {
    }
}