AccountPortals
Create, manipulate, and retrieve account-portals (portals of an account).
GET /account-portals
Retrieve a paginated list of account-portals, optionally filtered by account_login (our account id, eg : agxxxxxx) or account_external_id (your account id).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "account_portals": [ { "_links": { "self": { "href": "/account-portals[/:account_portal_id]" } }, "id": {integer}, "portal_code": {string}, "portal_name": {string}, "is_private": {boolean}, "portal_logo": {string}, "portal_url": {string}, "active": {boolean}, "max_ads": {integer}, "is_free": {boolean}, "last_sending_date": {string} }, { "_links": { "self": { "href": "/account-portals[/:account_portal_id]" } }, "active": {boolean}, "id": {integer}, "last_sending_date": {string}, "max_ads": {integer}, "portal_code": {string} } ] }, "_links": { "self": { "href": "/account-portals" }, "first": { "href": "/account-portals?page={page}" }, "prev": { "href": "/account-portals?page={page}" }, "next": { "href": "/account-portals?page={page}" }, "last": { "href": "/account-portals?page={page}" } }, "page": {integer}, "page_count": {integer}, "page_size": {integer}, "total_items": {integer} }
Accounts
Create, manipulate, and retrieve accounts.
GET /accounts
Retrieve a paginated list of accounts.
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "accounts": [ { "_links": { "self": { "href": "/accounts/{account_login}" }, "commercial_name": "{string}", "external_id": "{string}", "login": "{account_login}" } }, { "_links": { "self": { "href": "/accounts/{account_login}" }, "commercial_name": "{string}", "external_id": "{string}", "login": "{account_login}" } } ] }, "_links": { "self": { "href": "/accounts" }, "first": { "href": "/accounts?page={page}" }, "prev": { "href": "/accounts?page={page}" }, "next": { "href": "/accounts?page={page}" }, "last": { "href": "/accounts?page={page}" } } "page": {integer}, "page_count": {integer}, "page_size": {integer}, "total_items": {integer} }
GET /accounts[/:account_login]
Retrieve an account, providing account_login (our account id, eg : agxxxxxx) or account_external_id (your account id).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_links": { "self": { "href": "/accounts/{account_login}" } }, "billing_address_city": "{string}", "billing_address_postal_code": "{string}", "billing_address_street": "{string}", "client_code": "{string}", "commercial_name": "{string}", "company_name": "{string}", "contact_first_name": {string}", "contact_last_name": "{string}", "email": "{email}", "external_id": "{string}", "fax": "{string}", "login": "{account_login}", "phone": "{string}", "shipping_address_city": "{string}", "shipping_address_country": "{string}", "shipping_address_postal_code": "{string}", "shipping_address_street": "{string}", "siret": "{string}", "software": "{string}", "website": "{string}", "workforce": "{string}" }
AdPortals
Create, manipulate, and retrieve ad-portals (portals of an add).
GET /ad-portals
Retrieve a paginated list of ad-portals, providing an ad_ref (reference), and optionally filtered by account_login (our account id, eg : agxxxxxx) or account_external_id (your account id).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "ad_portals": [ { "_links": { "self": { "href": "http://api.localhost/ad-portals" } }, "active": {boolean}, "depublishing_order_sent": {boolean}, "id": {number}, "last_sent_order_date": "{date_iso8601}", "portal_code": "{string}", "portal_id": "{string}", "publishing_order_sent": {boolean}, "selection_update_date": "{date_iso8601}", "url": {url} } ] }, "_links": { "first": { "href": "http://api.localhost/ad-portals?ad_ref={ad_ref}" }, "last": { "href": "http://api.localhost/ad-portals?ad_ref={ad_ref}&page={page}" }, "self": { "href": "http://api.localhost/ad-portals?ad_ref={ad_ref}&page={page}" } }, "page": {number}, "page_count": {number}, "page_size": {number}, "total_items": {number} }
AdReports
Retrieve reports on a specific ad.
GET /ad-reports[/:ad_reports_id]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "action": "{string}", "id": {number}, "date": "{date_iso8601}", "id_flux": {number}, "annonceur": {number}, "annonce": "{string}", "code_interne": "{string}", "message": "{string}", "type": "{string}", "code": "{string}", "ss_code": "", }
Ads
Create, manipulate, and retrieve ads.
GET /ads
Retrieve a paginated list of ads, optionally filtered by account_login (our account id, eg : agxxxxxx) or account_external_id (your account id).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "ads": [ { "_links": { "self": { "href": "http://api.localhost/ads/{ad_ref}}" } }, "id": "{string}", "reference": "{string}", "state": "{string}", "title": "{string}" } ] }, "_links": { "first": { "href": "http://api.localhost/ads" }, "last": { "href": "http://api.localhost/ads?page={page}" }, "next": { "href": "http://api.localhost/ads?page={page}" }, "self": { "href": "http://api.localhost/ads?page={page}" } }, "page": {number}, "page_count": {number}, "page_size": {number}, "total_items": {number} }
GET /ads[/:ad_ref]
Retrieve an ad, providing an ad_ref (reference) and optionally filtered by account_login (our account id, eg : agxxxxxx) or account_external_id (your account id).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "adPortals": [ { "_links": { "self": { "href": "http://api.localhost/ad-portals" } }, "active": {boolean}, "depublishing_order_sent": {boolean}, "id": {number}, "last_sent_order_date": "{date_iso8601}", "portal_code": "{string}", "publishing_order_sent": {boolean}, "selection_update_date": "{date_iso8601}", "url": {url} } ] }, "_links": { "self": { "href": "http://api.localhost/ads/{ad_ref}" } }, "creation_date": "{date_iso8601}", "datas": { "CODE_POSTAL": "{string}", "DEPARTEMENT": "{string}", "PAYS": "{string}", "VILLE": "{string}", "VILLE_INSEE": "{string}", "VILLE_INSEE_EXACTE": {boolean} }, "id": "{string}", "insertion_date": "{date_iso8601}", "integration_date": "{date_iso8601}", "photos": [], "reference": "{string}", "state": "{string}", "text": "{string}", "title": "{string}", "video_url": "{url}" }
Categories
Retrieve a list of categories from a range (Real Estate, Used cars,...)
GET /categories
Retrieve a paginated list of categoies for a defined range
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_links": { "self": { "href": "/categories" }, "first": { "href": "/categories?page={page}" }, "prev": { "href": "/categories?page={page}" }, "next": { "href": "/categories?page={page}" }, "last": { "href": "/categories?page={page}" } } "_embedded": { "categories": [ { "_links": { "self": { "href": "/categories[/:categories_id]" } } } ] } }
GET /categories[/:category_id]
Retrieve details about one single category
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_links": { "self": { "href": "/categories[/:categories_id]" } } }
Contacts
Create, manipulate, and retrieve contacts.
GET /contacts
Retrieve a paginated list of contacts, optionally filtered by account_login (our account id, eg : agxxxxxx), account_external_id (your account id) or period.
A period is either a day in 'Y-m-d' format (period=2016-07-08) or a date range in ISO 8601 format (period=from2016-07-08T10:16:00+0200to2016-07-08T15:48:15+0200).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "contacts": [ { "_links": { "self": { "href": "/contacts/{contact_id}" } }, "id": {number} } ] }, "_links": { "first": { "href": "/contacts" }, "prev": { "href": "/contacts?page={page}" }, "next": { "href": "/contacts?page={page}" }, "last": { "href": "/contacts?page={page}" }, "self": { "href": "/contacts?page={page}" } }, "page": {number}, "page_count": {number}, "page_size": {number}, "total_items": {number} }
GET /contacts[/:contact_id]
Retrieve a contact, providing contact_id.
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "account": { "_links": { "self": { "href": "/accounts/{account_login}" } }, "commercial_name": "{string}", "external_id": "{string}", "login": "{account_login}" } }, "_links": { "self": { "href": "/contacts/{contact_id}" } }, "ad_reference": "{string}", "comment": "{string}", "id": {contact_id}, "identity": "{string}", "mail": "{email}", "phone": "{string}", "portal_code": "{string}", "portal_name": "{string}", "sent_date": "{date_iso8601}" }
Orders
Create, manipulate, and retrieve orders.
GET /orders
Retrieve a paginated list of orders.
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "orders": [ { "_embedded": { "account": { "_links": { "self": { "href": "http://api.localhost/accounts/{account_login}" } }, "commercial_name": "{string}", "external_id": "{string}", "login": "{account_login}" } }, "_links": { "self": { "href": "/orders/{order_number}" } } "date": "{Y-m-d}", "due_date": "{Y-m-d}", "name": "{string}", "number": "{order_number}", } ] }, "_links": { "self": { "href": "/orders" }, "first": { "href": "/orders?page={page}" }, "prev": { "href": "/orders?page={page}" }, "next": { "href": "/orders?page={page}" }, "last": { "href": "/orders?page={page}" } }, "page": {number}, "page_count": {number}, "page_size": {number}, "total_items": {number} }
POST /orders
Create a new order.
Fields
Field | Type | Description | Required |
---|---|---|---|
account_external_id | YES | ||
account_company_name | YES | ||
account_commercial_name | NO | ||
account_siret | NO | ||
account_email | YES | ||
account_website | NO | ||
account_phone | NO | ||
account_fax | NO | ||
account_workforce | NO | ||
account_software | NO | ||
account_shipping_address_street | YES | ||
account_shipping_address_street2 | NO | ||
account_shipping_address_postal_code | YES | ||
account_shipping_address_city | YES | ||
account_shipping_address_country | NO | ||
account_billing_address_street | NO | ||
account_billing_address_street2 | NO | ||
account_billing_address_postal_code | NO | ||
account_billing_address_city | NO | ||
account_contact_first_name | YES | ||
account_contact_last_name | YES | ||
order_product | YES | ||
order_due_date | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.classifieds.v1+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{ "account_external_id": "{string}", "account_company_name": "{string}", "account_commercial_name": "{string}", "account_siret": "{string}", "account_email": "{email}", "account_website": "{string}", "account_phone": "{string}", "account_fax": "{string}", "account_workforce": "{string}", "account_software": "{string}", "account_shipping_address_street": "{string}", "account_shipping_address_street2": "{string}", "account_shipping_address_postal_code": "{string}", "account_shipping_address_city": "{string}", "account_shipping_address_country": "{string}", "account_billing_address_street": "{string}", "account_billing_address_street2": "{string}", "account_billing_address_postal_code": "{string}", "account_billing_address_city": "{string}", "account_contact_first_name": "{string}", "account_contact_last_name": "{string}", "order_product": "{string}", "order_due_date": "{Y-m-d}", }
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "account": { "_links": { "self": { "href": "http://api.localhost/accounts/{account_login}" } }, "commercial_name": "{string}", "external_id": "{string}", "login": "{account_login}" } }, "_links": { "self": { "href": "http://api.localhost/orders/{order_number}" } }, "date": "{Y-m-d}", "due_date": "{Y-m-d}", "name": "{string}", "number": "{order_number}" }
GET /orders[/:order_number]
Retrieve an order, providing order_number (eg : C1234).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "account": { "_links": { "self": { "href": "http://api.localhost/accounts/{account_login}" } }, "commercial_name": "{string}", "external_id": "{string}", "login": "{account_login}" } }, "_links": { "self": { "href": "http://api.localhost/orders/{order_number}" } }, "date": "{Y-m-d H:i:s}", "delivery_date": "{Y-m-d H:i:s}", "due_date": "{Y-m-d}", "name": "{string}", "number": "{order_number}", "order_payment": "{string}", "status": "{string}" }
Reports
Create, manipulate, and retrieve reports.
GET /reports
Retrieve a paginated list of reports, optionally filtered by account_login (our account id, eg : agxxxxxx), account_external_id (your account id), period or feed_type.
A period is either a day in 'Y-m-d' format (period=2016-07-08) or a date range in ISO 8601 format (period=from2016-07-08T10:16:00+0200to2016-07-08T15:48:15+0200)
The feed_type filter accept values "incoming" (feeds received in our information system) and "outgoing" (feeds sent to portals).
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_embedded": { "reports": [ { "_links": { "self": { "href": "/reports[/:report_id]" } }, "id": {number}, "partner_code": "{string}", "start_date": "{date_iso8601}", "type": "{string}" }, { "_links": { "self": { "href": "/reports[/:report_id]" } }, "id": {number}, "partner_code": "{string}", "start_date": "{date_iso8601}", "type": "{string}" }, { "_links": { "self": { "href": "/reports[/:report_id]" } }, "id": {number}, "partner_code": "{string}", "start_date": "{date_iso8601}", "type": "{string}" }, { "_links": { "self": { "href": "/reports[/:report_id]" } }, "id": {number}, "partner_code": "{string}", "start_date": "{date_iso8601}", "type": "{string}" }, { "_links": { "self": { "href": "/reports[/:report_id]" } }, "id": {number}, "partner_code": "{string}", "start_date": "{date_iso8601}", "type": "{string}" }, { "_links": { "self": { "href": "/reports[/:report_id]" } }, "id": {number}, "partner_code": "{string}", "start_date": "{date_iso8601}", "type": "{string}" } ] }, "_links": { "self": { "href": "/reports" }, "first": { "href": "/reports?page={page}" }, "prev": { "href": "/reports?page={page}" }, "next": { "href": "/reports?page={page}" }, "last": { "href": "/reports?page={page}" } }, "page": {number}, "page_count": {number}, "page_size": {number}, "total_items": {number} }
GET /reports[/:reports_id]
Retrieve a report, providing a report_id and optionally filtered by account_login (our account id, eg : agxxxxxx) or account_external_id (your account id).
When the number of messages exceeds "messages_page_size", use "messages_page" argument to retrieve desired page.
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.classifieds.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
{ "_links": { "self": { "href": "/reports/[/:report_id]" } }, "ads_count": { "ADDED": "{number}", "DELETED": "{number}", "HANDLED": "{number}", "IDENTICAL": "{number}", "INVALID": "{number}", "MODIFIED": "{number}" }, "id": {number}, "messages": [ { "ad_reference": "{string}", "date": "{date_iso8601}", "level": "{string}", "message": "{string}" }, { "ad_reference": "{string}", "date": "{date_iso8601}", "level": "{string}", "message": "{string}" }, { "ad_reference": "{string}", "date": "{date_iso8601}", "level": "{string}", "message": "{string}" }, { "ad_reference": "{string}", "date": "{date_iso8601}", "level": "{string}", "message": "{string}" }, { "ad_reference": "{string}", "date": "{date_iso8601}", "level": "{string}", "message": "{string}" } ], "messages_count": {number}, "messages_page": {number}, "messages_page_count": {number}, "messages_page_size": {number} "partner_code": "{string}", "partner_name": "{string}", "photos_count": { "ADDED": "{number}", "DELETED": "{number}", "HANDLED": "{number}", "IDENTICAL": "{number}", "INVALID": "{number}", "MODIFIED": "{number}" }, "start_date": "{date_iso8601}", "stop_date": "{date_iso8601}", "type": "{string}" }