Documentation Powered by ReDoc

(0.0.0)

Download OpenAPI specification:Download

Authentication

apiKey

Value for the Authorization header parameter.

Security Scheme Type API Key
Header parameter name: Authorization

Company

Retrieves the collection of Company resources.

Retrieves the collection of Company resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Company resource.

Creates a Company resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new Company resource

email
string
siret
string or null
address
string or null
city
string or null
zipcode
string or null
phone
string or null
url
string or null
Array of objects (UserHasCompanyRole.jsonld)
Array of objects (Role.jsonld)
name
string
slug
string
Array of objects (Invitation.jsonld)
(FollowUp.jsonld (object or null))
Array of objects (Review.jsonld)
Array of objects (ProductReview.jsonld)
rating
number or null
Array of objects (ReviewImport.jsonld)
title
string or null
h1
string or null
ratingText
string or null
tva
string or null
(FollowUpOrder.jsonld (object or null))
Array of objects (Command.jsonld)
totalReviews
integer or null
TotalReviewTwoYears
integer or null
displayProductReviews
boolean or null
nps
boolean
deletedAt
string or null <date-time>
Array of objects (Export.jsonld)
Array of objects (Import.jsonld)
autoModeration
boolean
apiLikeRef
boolean
Array of objects (Prompt.jsonld)
(StoredFile.jsonld (object or null))
(StoredFile.jsonld (object or null))
shortDescription
string or null
longDescription
string or null
(CompanyType.jsonld (object or null))
(CompanyCategory.jsonld (object or null))
(CompanyContactRepresentative.jsonld (object or null))
(CompanyTechnicalContact.jsonld (object or null))
(CompanyDPOContact.jsonld (object or null))
createdAt
string <date-time>
ratingCount
integer or null
companyCreatedAt
string or null <date-time>
metaDescription
string or null
(CompanyIndex.jsonld (object or null))
totalReviewTwoYears
integer or null
displayPublic
boolean
displayPublicGes
boolean

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "email": "string",
  • "siret": "string",
  • "address": "string",
  • "city": "string",
  • "zipcode": "string",
  • "phone": "string",
  • "url": "string",
  • "userHasCompanyRoles": [
    ],
  • "roles": [
    ],
  • "name": "string",
  • "slug": "string",
  • "invitations": [
    ],
  • "followUp": {
    },
  • "reviews": [
    ],
  • "productReviews": [
    ],
  • "rating": 0,
  • "reviewImports": [
    ],
  • "title": "string",
  • "h1": "string",
  • "ratingText": "string",
  • "tva": "string",
  • "followUpOrder": {
    },
  • "commands": [
    ],
  • "totalReviews": 0,
  • "TotalReviewTwoYears": 0,
  • "displayProductReviews": true,
  • "nps": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "export": [
    ],
  • "imports": [
    ],
  • "autoModeration": true,
  • "apiLikeRef": true,
  • "prompts": [
    ],
  • "squareLogo": {
    },
  • "rectangularLogo": {
    },
  • "shortDescription": "string",
  • "longDescription": "string",
  • "companyType": {
    },
  • "companyCategory": {
    },
  • "companyContactRepresentative": {
    },
  • "companyTechnicalContact": {
    },
  • "companyDpoContact": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "ratingCount": 0,
  • "companyCreatedAt": "2019-08-24T14:15:22Z",
  • "metaDescription": "string",
  • "companyIndex": {
    },
  • "totalReviewTwoYears": 0,
  • "displayPublic": true,
  • "displayPublicGes": true
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "slug": "string"
}

Retrieves a Company resource.

Retrieves a Company resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "slug": "string"
}

Retrieves a Company resource.

Retrieves a Company resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "slug": "string"
}

Token

Get JWT token to login.

Generate new JWT Token

Authorizations:
apiKey
Request Body schema: application/json

Generate new JWT Token

email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@example.com",
  • "password": "apassword"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Order

Creates a Order resource.

Creates a Order resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new Order resource

orderNumber
string
customerEmail
string
firstname
string or null
lastname
string or null
mailSent
boolean or null
customerPhone
string or null

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "orderNumber": "string",
  • "customerEmail": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "mailSent": true,
  • "customerPhone": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "customerEmail": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "follow_up": 0,
  • "mailSent": true,
  • "customerPhone": "string"
}

Retrieves a Order resource.

Retrieves a Order resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "customerEmail": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "follow_up": 0,
  • "mailSent": true,
  • "customerPhone": "string"
}

ProductOrder

Creates a ProductOrder resource.

Creates a ProductOrder resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new ProductOrder resource

object (Order.jsonld-write)
name
string
reference
string or null
freeField
string or null
image
string or null
followUp
integer or null
link
string or null

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "orderParent": {
    },
  • "name": "string",
  • "reference": "string",
  • "freeField": "string",
  • "image": "string",
  • "followUp": 0,
  • "link": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderParent": {
    },
  • "name": "string",
  • "reference": "string",
  • "freeField": "string",
  • "image": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "followUp": 0,
  • "link": "string"
}

Retrieves a ProductOrder resource.

Retrieves a ProductOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderParent": {
    },
  • "name": "string",
  • "reference": "string",
  • "freeField": "string",
  • "image": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "followUp": 0,
  • "link": "string"
}

ProductReview

get_all_product_reviewProductReviewCollection

Retrieves the collection of ProductReview resources.

Authorizations:
apiKey
query Parameters
status
any
rating
any
orderNumber
any
customerEmail
any
username
any
productName
any
reference
any
content
any
startDate
any

jj/mm/yyyy

endDate
any

jj/mm/yyyy

page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

reference[]
Array of strings

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a ProductReview resource.

Creates a ProductReview resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new ProductReview resource

content
string
rating
integer
status
string <iri-reference>
browser
Array of strings or null
object (Order.jsonld-write)
createdAt
string <date-time>
customerIp
string or null
image
string or null
freeField
string or null
reference
string or null
productName
string
company
string <iri-reference>
link
string or null

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "content": "string",
  • "rating": 0,
  • "status": "../словник",
  • "browser": [
    ],
  • "orderParent": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerIp": "string",
  • "image": "string",
  • "freeField": "string",
  • "reference": "string",
  • "productName": "string",
  • "company": "../словник",
  • "link": "string",
  • "public_user": { }
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "content": "string",
  • "rating": 0,
  • "status": "../словник",
  • "browser": [
    ],
  • "orderParent": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerIp": "string",
  • "image": "string",
  • "freeField": "string",
  • "reference": "string",
  • "productName": "string",
  • "company": {
    },
  • "link": "string",
  • "public_user": {
    }
}

Retrieves a ProductReview resource.

Retrieves a ProductReview resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "content": "string",
  • "rating": 0,
  • "status": "../словник",
  • "browser": [
    ],
  • "orderParent": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerIp": "string",
  • "image": "string",
  • "freeField": "string",
  • "reference": "string",
  • "productName": "string",
  • "company": {
    },
  • "link": "string",
  • "public_user": {
    }
}

Retrieves a ProductReview resource.

Retrieves a ProductReview resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "content": "string",
  • "rating": 0,
  • "status": "../словник",
  • "browser": [
    ],
  • "orderParent": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerIp": "string",
  • "image": "string",
  • "freeField": "string",
  • "reference": "string",
  • "productName": "string",
  • "company": {
    },
  • "link": "string",
  • "public_user": {
    }
}

get_one_product_reviewProductReviewItem

Retrieves a ProductReview resource.

Authorizations:
apiKey
path Parameters
id
required
any

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "content": "string",
  • "rating": 0,
  • "status": "../словник",
  • "browser": [
    ],
  • "orderParent": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerIp": "string",
  • "image": "string",
  • "freeField": "string",
  • "reference": "string",
  • "productName": "string",
  • "company": {
    },
  • "link": "string",
  • "public_user": {
    }
}

ReviewStatus

Creates a ReviewStatus resource.

Creates a ReviewStatus resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new ReviewStatus resource

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{ }

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Retrieves a ReviewStatus resource.

Retrieves a ReviewStatus resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Review

get_all_reviewReviewCollection

Retrieves the collection of Review resources.

Authorizations:
apiKey
query Parameters
status
any
rating
any
nps
any

0 à 10 ou non

orderNumber
any
customerEmail
any
username
any
content
any
startDate
any

jj/mm/yyyy

endDate
any

jj/mm/yyyy

page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Review resource.

Creates a Review resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new Review resource

purchaseDate
string <date-time>
customerEmail
string
content
string
createdAt
string <date-time>
rating
integer
customerIp
string or null
status
string <iri-reference>
browser
Array of strings or null
company
string or null <iri-reference>
object (Order.jsonld-write)

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "customerEmail": "string",
  • "content": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "rating": 0,
  • "customerIp": "string",
  • "status": "../словник",
  • "browser": [
    ],
  • "company": "../словник",
  • "orderParent": {
    }
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "customerEmail": "string",
  • "content": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "rating": 0,
  • "customerIp": "string",
  • "status": "../словник",
  • "browser": [
    ],
  • "company": {
    },
  • "orderParent": {
    }
}

get_one_reviewReviewItem

Retrieves a Review resource.

Authorizations:
apiKey
path Parameters
id
required
any

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "customerEmail": "string",
  • "content": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "rating": 0,
  • "customerIp": "string",
  • "status": "../словник",
  • "browser": [
    ],
  • "company": {
    },
  • "orderParent": {
    }
}

getReviewCollection

Retrieves the collection of Review resources.

Authorizations:
apiKey
query Parameters
rating
any
nps
any

0 à 10 ou non

customerEmail
any
content
any
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

status
string

Filter reviews by status (published, moderation, refused, autoModeration)

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Webhook

Creates a Webhook resource.

Creates a Webhook resource.

Authorizations:
apiKey
Request Body schema:
application/ld+json
application/ld+json
application/json
text/html

The new Webhook resource

url
string
siteId
string or null

Responses

Request samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "url": "string",
  • "siteId": "string"
}

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "url": "string",
  • "siteId": "string"
}

Retrieves a Webhook resource.

Retrieves a Webhook resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
application/ld+json
application/json
text/html
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "url": "string",
  • "siteId": "string"
}
Available formats: jsonld json html
Other API docs: Swagger UI GraphiQL