About

Authentication

Authentication is handled by a Basic Authorization and needs an API key. An API key is formed by client_id and client_secret.
You must provide an HTTP header Authorization as follow :
Authorization: Basic token
where token is equal to client_id:client_secret encoded in base64

Sample


client_id is equal to So and client_secret is equal to Use, you must provide this HTTP header :
            Authorization: Basic U286VXNl
        
If Authorization header is not provided or not valid, an HTTP error is returned with status code 502

Quotas

Quotas calls remaining are provided in HTTP Response. Quotas available are Opun-Daily-Calls-Remaining, Opun-Monthly-Calls-Remaining
When quotas are exceeded, an HTTP error is returned with HTTP status 429

Custom types

In payload, you should use some types like Place, Date, DateTime or strings for AccommodationTypes, ActivitesTypes and TransportTypes

Date


Date type is handled by yyyy-MM-dd format

DateTime


DateTime type is handled by yyyy-MM-dd'T'HH:mm:ss.SSSZZ format

Place


Place type is handled by a JSON object as follow (location field is not required but recommended):
            
            {
                "label": "Paris",
                "location": {
                    "lat": 48.856614,
                    "lon": 2.3522219
                }
            }
            
        

Accommodation types


Valid accommodation types are : APARTMENT, HOUSE, BOAT, BNB, CARAVAN, CABIN, VILLA, CASTLE, GARDEN_HOUSE, BARN, BACK_GARDEN_CAMPSITE, MOBILHOME, BUNGALOW, HOTEL and OTHER

Activities types


Valid activities types are : RAMBLE, CULTURE, SPORTS, HERITAGE, CRAFTS, GASTRONOMY, GAME, PHOTOS and OTHER

Transport types


Valid transport types are : PLANE, BOAT, TRAIN, CAR_SHARING, BUS, OWN_CAR, TRAIN_BUS and OTHER

Infos API

GET /infos/categories

Get all available categories and partners

curl example

    curl -X GET "https://api.souse.com/v1/infos/categories" \
     -H "Accept: application/json" \
     -H "Authorization: Basic XXXXXXXXXXXX"
  

response example

    {
  "fooding":["voulezVousDiner","nicetomealyou","avekapeti","vizeat"],
  "transportrent":["travelerCar","koolicar","yescapa"],
  "course":["playeur","trainme","yelp","monptivoisinage"],
  "accommodation":["homeAway","sejourning","gamping","bedycasa","misterBnb","nineFlats","handivoyage"],
  "activities":["francebillet","sharemysea","reservons","yeswegreen","meetup"],
  "service":["needelp","mesdepanneurs","animovacances","monptivoisinage","stootie","cowash","wepetsitty"],
  "transport":["driiveme","ouibus","blablacar","gomore"],
  "placerent":["uponup","leasyt","jestocke"],
  "parking":["travelerPark","monsieurparking","yelp","travelerParkFree","monptivoisinage","zenpark"],
  "objects":["bricolib","mutum","separtagerunbien","monptivoisinage"]
}
  

errors

HTTP status Error description
502 No API Key provided

Search API

POST /search/accommodation

Search for accommodations

Parameters

Name Type Description Required Default value
places [Place] The place where to find an accommodation Yes Geolocation of Paris, France
startDate Date Start date Yes Date of today
endDate Date End date Yes Date of startDate plus one day
guestsNumber Integer Guests number Yes 1
accommodationTypes [String] Accommodation types. If not filled, all accommodation types are used. Else, take only values of this array No No values. Be careful, no values is different to empty array
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/accommodation" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "startDate" : "2017-10-16",
        "endDate" : "2017-10-22",
        "guestsNumber": 2,
        "accommodationTypes": ["APARTMENT", "BNB", "MOBILHOME"],
        "partners": ["nineFlats", "bedycasa]
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/activities

Search for activities

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
startDate DateTime Start date No Now
endDate Date End date No Date of startDate plus one day
nbPersons Integer Number of persons No 1
what String Keywords No No value
activitiesTypes [String] Activities types. If not filled, all activities types are used. Else, take only values of this array No No values. Be careful, no values is different to empty array
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/activities" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "startDate" : "2017-10-16T08:30:00.000Z",
        "endDate" : "2017-10-18T09:00:00.000Z",
        "nbPersons": 1,
        "activitiesTypes": ["RAMBLE", "SPORTS"]
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/course

Search for course

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
what String Keywords No No value
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/course" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "what": "fitness"
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/fooding

Search for fooding

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
when Date When No No value
guests Integer Guests number No 1
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/fooding" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "guests": 2
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/objects

Search for objects

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
what String Keywords No No value
startDate Date Start date No No value
endDate Date End date No No value
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/objects" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "what": "fitness"
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/parking

Search for parking

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
startDate DateTime Start date No Now plus one hour
endDate Date End date No Date and time of startDate plus two hours
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/parking" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "startDate" : "2017-10-16T08:30:00.000Z",
        "endDate" : "2017-10-16T10:30:00.000Z"
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/placerent

Search for venue hire

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
startDate DateTime Start date No Now plus one hour
endDate Date End date No Date and time of startDate plus two hours
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/placerent" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "startDate" : "2017-10-16T08:30:00.000Z",
        "endDate" : "2017-10-16T10:30:00.000Z"
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/service

Search for objects

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
what String Keywords No Empty value
startDate Date Start date No No value
endDate Date End date No No value
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/service" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "places": [{
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        }],
        "what": "babysitting"
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/transport

Search for transport

Parameters

Name Type Description Required Default value
from Place Departure Yes No value
to Place Arrival Yes No value
startDate DateTime Start date No Now plus 5 minutes
nbPassengers Integer Number of passengers No 1
transportTypes [String] Transport types. If not filled, all transport types are used. Else, take only values of this array No No values. Be careful, no values is different to empty array
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

    curl -X POST "https://api.souse.com/v1/search/transport" \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -H "Authorization: Basic XXXXXXXXXXXX" -d '
      {
        "from": {
          "label": "Paris",
          "location": {
            "lat": 48.856614,
            "lon": 2.3522219
          }
        },
        "to": {
          "label": "Niort",
          "location": {
            "lat": 46.323716,
            "lon": -0.4647770000000264
          }
        },
        "startDate" : "2017-10-16T08:30:00.000Z"
        "nbPassengers": 2
      }
      '
  

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/transportrent

Search for transport rental

Parameters

Name Type Description Required Default value
places [Place] The place where to find activities Yes Geolocation of Paris, France
startDate DateTime Start date No Now plus one hour
endDate Date End date No Date and time of startDate plus two hours
seats Integer Number of passengers No 1
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

        curl -X POST "https://api.souse.com/v1/search/transport" \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -H "Authorization: Basic XXXXXXXXXXXX" -d '
            {
                "places": [
                    {
                    "label": "paris",
                        "location": {
                            "lat": 48.8566,
                            "lon": 2.35222
                        }
                    }
                ],
                "startDate": "2018-01-13T15:00:00.000Z",
                "endDate": "2018-01-14T15:00:00.000Z",
                "seats": 2
            }
            '
    

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided

POST /search/urbantransport

Search for urban transport

Parameters

Name Type Description Required Default value
from Place Departure Yes No value
to Place Arrival Yes No value
startDate DateTime Start date No Now plus 5 minutes
nbPassengers Integer Number of passengers No 1
partners [String] Partners. If not filled, all partners are used. Else, take only values of this array No No values. Be careful, no values is different to empty array

curl example

        curl -X POST "https://api.souse.com/v1/search/transport" \
            -H "Content-Type: application/json" \
            -H "Accept: application/json" \
            -H "Authorization: Basic XXXXXXXXXXXX" -d '
            {
                "from": {
                    "label": "Paris",
                    "location": {
                        "lat": 48.856614,
                        "lon": 2.3522219
                    }
                },
                "to": {
                    "label": "Niort",
                    "location": {
                        "lat": 46.323716,
                        "lon": -0.4647770000000264
                    }
                },
                "startDate" : "2017-10-16T08:30:00.000Z"
                "nbPassengers": 2
            }
            '
    

Errors

HTTP status Error description
400 Malformed search parameters
502 No API Key provided