API documentation

_others

/api/adverts

GET /api/adverts
- Récupère la liste des articles
- Documentation
- Sandbox
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/adverts

Publie un article

GET /api/adverts/{id}
- Récupère un article depuis son id
- Documentation
- Sandbox
Requirements

Name Requirement Type Description

id
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line
DELETE /api/adverts/{slug]
- Supprime un article
- Documentation
- Sandbox
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line
GET /api/adverts/{slug}
- Récupère un article
- Documentation
- Sandbox
Requirements

Name Requirement Type Description

slug
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line
PUT /api/adverts/{slug}
- édite un article
- Documentation
- Sandbox
Requirements

Name Requirement Type Description

slug
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Parameter	Type	Required?
api_advert	object (ApiAdvertType)	true
api_advert[title]	string	true
api_advert[slug]	string	true
api_advert[content]	string	true
api_advert[rubrique]	choice	false

Name	Requirement	Type	Description
id

Name	Requirement	Type	Description
slug

Name	Requirement	Type	Description
slug

/api/users

GET /api/users

Récupère la liste des utilisateurs

POST /api/users

Crée un compte

/api/users/{slug}
- - GET /api/users/{slug}
    - Récupère un utilisateur
    - Documentation
    - Sandbox
    Requirements
    
    Name Requirement Type Description
    
    slug
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line
  - PATCH /api/users/{slug}
    - Met à jour l'attribut email
    - Documentation
    - Sandbox
    Requirements
    
    Name Requirement Type Description
    
    slug
    
    Return
    
    Parameter Type Versions Description
    
    200
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line
  - PUT /api/users/{slug}
    - Met à jour ...
    - Documentation
    - Sandbox
    Requirements
    
    Name Requirement Type Description
    
    slug
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line

- - GET /api/rubrique/{slug}/adverts
    - Récupère la liste des articles par rubrique
    - Documentation
    - Sandbox
    Requirements
    
    Name Requirement Type Description
    
    slug
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line
  - GET /api/user/{slug}/adverts
    - Récupère la liste des articles par auteur
    - Documentation
    - Sandbox
    Requirements
    
    Name Requirement Type Description
    
    slug
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Request body
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
    
    Curl Command Line

Parameter	Type	Required?
api_registration	object (ApiRegistrationType)	true
api_registration[username]	string	true
api_registration[email]	string	true
api_registration[password]	string	true

API documentation

/api/adverts

GET /api/adverts

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/adverts

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/adverts/{id}

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/adverts/{slug]

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/adverts/{slug}

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/adverts/{slug}

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/users

GET /api/users

Filters

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/users

Parameters

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/users/{slug}

GET /api/users/{slug}

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PATCH /api/users/{slug}

Requirements

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]